From 7b919de23403d48b742b26c254b0a63d42a24a69 Mon Sep 17 00:00:00 2001 From: Dean Attali Date: Mon, 2 Mar 2015 22:54:59 -0800 Subject: [PATCH] add more docs --- README.md | 28 ++++++++++++++++++++++++---- 1 file changed, 24 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7891a63..baa4a9a 100644 --- a/README.md +++ b/README.md @@ -24,19 +24,39 @@ Edit the `_config.yml` file to change all the settings to reflect your site. Th You can now visit your shiny new website, which will be seeded with several sample blog posts and a couple other pages. + +![Installation steps](img/install-steps.gif) + ### Add your own content To add pages to your site, you can either write a markdown file (`.md`) which will automatically get converted to HTML, or you can write an HTML file directly. It is much easier to write mardown; you write normal text with a few styling identifiers, and Jekyll will know how to automatically render it as a pretty HTML page. Markdown is extremely easy to use, just [look at the reference](http://daringfireball.net/projects/markdown/syntax) and at some files on the site to get an idea. Any markdown or HTML file you add to the root directory will be immediately available on your site. Take a look at the `aboutme.md` and `index.html` files as examples. Any file inside the `_posts` directory will be treated as a blog entry. You can look at the existing files there to get an idea of how to write blog posts, and delete them when you feel ready. +### Features +- mobile +- avatar +- footer links +- navbar links +- YAML params +- page types +### Project page vs user page -known bug (problem on GitHub Pages part) - if you have a project page and want a custom 404 page, you must use a custom domain. See https://help.github.com/articles/custom-404-pages/. This means that if you have a regular User Page you can use the 404 page from this theme, but if it's a website for a specific repository, the 404 page will not be used. - -can also give googlefonts +If you want to use this as a project page for a specific repository instead of your main GitHub user page, th ### Credits -This template was not created 100% from scratch; I've used ideas and some code snippets from [Jekyll Now](https://github.com/barryclark/jekyll-now) and [Bootstrap Clean Blog](https://github.com/IronSummitMedia/startbootstrap-clean-blog) + +This template was not made entirely from scratch. I would like to give special thanks to: +- [Barry Clark](https://github.com/barryclark) and his project [Jekyll Now](https://github.com/barryclark/jekyll-now), from whom I've taken several ideas and code snippets, as well as some documenation tips. +- [Iron Summit Media](https://github.com/IronSummitMedia) and their project [Bootstrap Clean Blog](https://github.com/IronSummitMedia/startbootstrap-clean-blog), from which I've used some design ideas and some of the templating code for posts and pagination. + +### Contributions + +If you find anything wrong or would like to contribute it any way, feel free to create a pull request/open an issue/send me a message. Any comments are welcome! + +### Known bugs + +- If you have a project page and you want a custom 404 page, you must have a custom domain. See https://help.github.com/articles/custom-404-pages/. This means that if you have a regular User Page you can use the 404 page from this theme, but if it's a website for a specific repository, the 404 page will not be used.