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.
This commit is contained in:
		
							parent
							
								
									004125bcd2
								
							
						
					
					
						commit
						990d13cb17
					
				| 
						 | 
					@ -5,6 +5,9 @@
 | 
				
			||||||
      <li class="{% if page.title == "Welcome" %}current{% endif %}">
 | 
					      <li class="{% if page.title == "Welcome" %}current{% endif %}">
 | 
				
			||||||
        <a href="{{ site.url }}/docs/home">Welcome</a>
 | 
					        <a href="{{ site.url }}/docs/home">Welcome</a>
 | 
				
			||||||
      </li>
 | 
					      </li>
 | 
				
			||||||
 | 
					      <li class="{% if page.title == "Quick-start guide" %}current{% endif %}">
 | 
				
			||||||
 | 
					        <a href="{{ site.url }}/docs/quickstart">Quick-start guide</a>
 | 
				
			||||||
 | 
					      </li>
 | 
				
			||||||
      <li class="{% if page.title == "Installation" %}current{% endif %}">
 | 
					      <li class="{% if page.title == "Installation" %}current{% endif %}">
 | 
				
			||||||
        <a href="{{ site.url }}/docs/installation">Installation</a>
 | 
					        <a href="{{ site.url }}/docs/installation">Installation</a>
 | 
				
			||||||
      </li>
 | 
					      </li>
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -3,6 +3,7 @@
 | 
				
			||||||
    <option value="">Navigate the docs…</option>
 | 
					    <option value="">Navigate the docs…</option>
 | 
				
			||||||
    <optgroup label="Getting started">
 | 
					    <optgroup label="Getting started">
 | 
				
			||||||
      <option value="{{ site.url }}/docs/home">Welcome</option>
 | 
					      <option value="{{ site.url }}/docs/home">Welcome</option>
 | 
				
			||||||
 | 
					      <option value="{{ site.url }}/docs/quickstart">Quick-start guide</option>
 | 
				
			||||||
      <option value="{{ site.url }}/docs/installation">Installation</option>
 | 
					      <option value="{{ site.url }}/docs/installation">Installation</option>
 | 
				
			||||||
      <option value="{{ site.url }}/docs/usage">Basic Usage</option>
 | 
					      <option value="{{ site.url }}/docs/usage">Basic Usage</option>
 | 
				
			||||||
      <option value="{{ site.url }}/docs/structure">Directory structure</option>
 | 
					      <option value="{{ site.url }}/docs/structure">Directory structure</option>
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -1,7 +1,7 @@
 | 
				
			||||||
---
 | 
					---
 | 
				
			||||||
layout: docs
 | 
					layout: docs
 | 
				
			||||||
title: Welcome
 | 
					title: Welcome
 | 
				
			||||||
next_section: installation
 | 
					next_section: quickstart
 | 
				
			||||||
permalink: /docs/home/
 | 
					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
 | 
					to host your project’s page, blog, or website from GitHub’s servers **for
 | 
				
			||||||
free**.
 | 
					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
 | 
					## ProTips™, Notes, and Warnings
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Throughout this guide there are a number of small-but-handy pieces of
 | 
					Throughout this guide there are a number of small-but-handy pieces of
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -1,7 +1,7 @@
 | 
				
			||||||
---
 | 
					---
 | 
				
			||||||
layout: docs
 | 
					layout: docs
 | 
				
			||||||
title: Installation
 | 
					title: Installation
 | 
				
			||||||
prev_section: home
 | 
					prev_section: quickstart
 | 
				
			||||||
next_section: usage
 | 
					next_section: usage
 | 
				
			||||||
permalink: /docs/installation/
 | 
					permalink: /docs/installation/
 | 
				
			||||||
---
 | 
					---
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -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.
 | 
				
			||||||
		Loading…
	
		Reference in New Issue