mirror of
https://github.com/jekyll/jekyll.git
synced 2026-02-10 06:35:10 -05:00
990d13cb17
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.
53 lines
2.0 KiB
Markdown
53 lines
2.0 KiB
Markdown
---
|
||
layout: docs
|
||
title: Welcome
|
||
next_section: quickstart
|
||
permalink: /docs/home/
|
||
---
|
||
|
||
This site aims to be a comprehensive guide to Jekyll. We’ll cover topics such
|
||
as getting your site up and running, creating and managing your content,
|
||
customizing the way your site works and looks, deploying to various
|
||
environments, and give you some advice on participating in the future
|
||
development of Jekyll itself.
|
||
|
||
## So what is Jekyll, exactly?
|
||
|
||
Jekyll is a simple, blog-aware, static site generator. It takes a template
|
||
directory containing raw text files in various formats, runs it through
|
||
[Markdown](http://daringfireball.net/projects/markdown/) (or
|
||
[Textile](http://textile.sitemonks.com/)) and
|
||
[Liquid](http://wiki.shopify.com/Liquid)
|
||
converters, and spits out a complete, ready-to-publish static website suitable
|
||
for serving with your favorite web server. Jekyll also happens to be the engine
|
||
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**.
|
||
|
||
## ProTips™, Notes, and Warnings
|
||
|
||
Throughout this guide there are a number of small-but-handy pieces of
|
||
information that can make using Jekyll easier, more interesting, and less
|
||
hazardous. Here’s what to look out for.
|
||
|
||
<div class="note">
|
||
<h5>ProTips™ help you get more from Jekyll</h5>
|
||
<p>These are tips and tricks that will help you be a Jekyll wizard!</p>
|
||
</div>
|
||
|
||
<div class="note info">
|
||
<h5>Notes are handy pieces of information</h5>
|
||
<p>These are for the extra tidbits sometimes necessary to understand
|
||
Jekyll.</p>
|
||
</div>
|
||
|
||
<div class="note warning">
|
||
<h5>Warnings help you not blow things up</h5>
|
||
<p>Be aware of these messages if you wish to avoid certain death.</p>
|
||
</div>
|
||
|
||
If you come across anything along the way that we haven’t covered, or if you
|
||
know of a tip you think others would find handy, please [file an
|
||
issue](https://github.com/mojombo/jekyll/issues/new) and we’ll see about
|
||
including it in this guide.
|