From 990d13cb179089359495f6c6d143061b18a546c2 Mon Sep 17 00:00:00 2001 From: Phil Leggetter Date: Fri, 7 Jun 2013 11:54:01 +0100 Subject: [PATCH] Moving Quick-start guide to own section As a new user to jekyll I wanted to get up and running as quickly as possible. The first thing I did was jump to the docs (missing the example on the homepage - my bad) and look for the quick start guide. Since I couldn't find one I went for the 'Basic Usage' section. I ended up muddling around for about 10 minutes until I hit the home page again to see the simple - and very easy - example of how to get started. So, in this pull request I've moved the Quick-start Guide out to it's own section so that users who really are impatient (like me) can clearly look for and jump to the quick start guide, follow the super-easy steps, and be up and running in a matter of minutes. Interested to hear if this is thought of as being a good idea. --- site/_includes/docs_contents.html | 3 +++ site/_includes/docs_contents_mobile.html | 1 + site/docs/index.md | 18 +----------------- site/docs/installation.md | 2 +- site/docs/quickstart.md | 21 +++++++++++++++++++++ 5 files changed, 27 insertions(+), 18 deletions(-) create mode 100644 site/docs/quickstart.md diff --git a/site/_includes/docs_contents.html b/site/_includes/docs_contents.html index 29c64c78..6654abb4 100644 --- a/site/_includes/docs_contents.html +++ b/site/_includes/docs_contents.html @@ -5,6 +5,9 @@
  • Welcome
  • +
  • + Quick-start guide +
  • Installation
  • diff --git a/site/_includes/docs_contents_mobile.html b/site/_includes/docs_contents_mobile.html index 30446d4d..f2fe6c5b 100644 --- a/site/_includes/docs_contents_mobile.html +++ b/site/_includes/docs_contents_mobile.html @@ -3,6 +3,7 @@ + diff --git a/site/docs/index.md b/site/docs/index.md index 5129643a..56571186 100644 --- a/site/docs/index.md +++ b/site/docs/index.md @@ -1,7 +1,7 @@ --- layout: docs title: Welcome -next_section: installation +next_section: quickstart permalink: /docs/home/ --- @@ -24,22 +24,6 @@ behind [GitHub Pages](http://pages.github.com), which means you can use Jekyll to host your project’s page, blog, or website from GitHub’s servers **for free**. -## Quick-start guide - -For the impatient, here's how to get a boilerplate Jekyll site up and running. - -{% highlight bash %} -~ $ gem install jekyll -~ $ jekyll new myblog -~ $ cd myblog -~/myblog $ jekyll serve -# => Now browse to http://localhost:4000 -{% endhighlight %} - -That's nothing, though. The real magic happens when you start creating blog -posts, using the front-matter to control templates and layouts, and taking -advantage of all the awesome configuration options Jekyll makes available. - ## ProTips™, Notes, and Warnings Throughout this guide there are a number of small-but-handy pieces of diff --git a/site/docs/installation.md b/site/docs/installation.md index 1ba2fc3b..e559f330 100644 --- a/site/docs/installation.md +++ b/site/docs/installation.md @@ -1,7 +1,7 @@ --- layout: docs title: Installation -prev_section: home +prev_section: quickstart next_section: usage permalink: /docs/installation/ --- diff --git a/site/docs/quickstart.md b/site/docs/quickstart.md new file mode 100644 index 00000000..f7ee7b4e --- /dev/null +++ b/site/docs/quickstart.md @@ -0,0 +1,21 @@ +--- +layout: docs +title: Quick-start guide +prev_section: home +next_section: installation +permalink: /docs/quickstart/ +--- + +For the impatient, here's how to get a boilerplate Jekyll site up and running. + +{% highlight bash %} +~ $ gem install jekyll +~ $ jekyll new myblog +~ $ cd myblog +~/myblog $ jekyll serve +# => Now browse to http://localhost:4000 +{% endhighlight %} + +That's nothing, though. The real magic happens when you start creating blog +posts, using the front-matter to control templates and layouts, and taking +advantage of all the awesome configuration options Jekyll makes available. \ No newline at end of file