From 24df53be20e66ebd2a2acc1581b40d6f7682c4c2 Mon Sep 17 00:00:00 2001 From: Awjin Ahn Date: Wed, 18 Apr 2018 14:09:24 -0700 Subject: [PATCH] Update index.md (#6933) Merge pull request 6933 --- docs/_docs/index.md | 51 ++++++++++++++++----------------------------- 1 file changed, 18 insertions(+), 33 deletions(-) diff --git a/docs/_docs/index.md b/docs/_docs/index.md index f5077201..cbe0bd89 100644 --- a/docs/_docs/index.md +++ b/docs/_docs/index.md @@ -4,53 +4,38 @@ permalink: /docs/home/ redirect_from: /docs/index.html --- -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. +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 content, customizing your build, and deploying. -## So what is Jekyll, exactly? +## 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 -a converter (like [Markdown](https://daringfireball.net/projects/markdown/)) -and our [Liquid](https://shopify.github.io/liquid/) renderer, 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](https://pages.github.com), which means you can use Jekyll -to host your project’s page, blog, or website from GitHub’s servers **for -free**. +Jekyll is a simple, blog-aware, static site generator. -## Helpful Hints +You create your content as text files ([Markdown](https://daringfireball.net/projects/markdown/)), and organize them into folders. Then, you build the shell of your site using [Liquid](https://shopify.github.io/liquid/)-enhanced HTML templates. Jekyll automatically stitches the content and templates together, generating a website made entirely of static assets, suitable for uploading to any server. -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. +Jekyll happens to be the engine behind [GitHub Pages](https://pages.github.com), so you can host your project’s Jekyll page/blog/website on GitHub’s servers **for free**. + +## Navigating the Guide + +Throughout this guide, you'll see these special sections that help you get the most out of Jekyll:
-
ProTips™ help you get more from Jekyll
-

These are tips and tricks that will help you be a Jekyll wizard!

+
ProTips™
+

Tips and tricks that'll make you a Jekyll wizard!

-
Notes are handy pieces of information
-

These are for the extra tidbits sometimes necessary to understand - Jekyll.

+
Notes
+

Extra tidbits that are sometimes necessary to understand Jekyll.

-
Warnings help you not blow things up
-

Be aware of these messages if you wish to avoid certain death.

+
Warnings
+

Common pitfalls to avoid.

-
You'll see this by a feature that hasn't been released
-

Some pieces of this website are for future versions of Jekyll that - are not yet released.

+
Unreleased
+

Features planned for future versions of Jekyll, but not available yet.

-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]({{ site.repository }}/issues/new) and we’ll see about -including it in this guide. +If you find anything we haven’t covered, or would like to share a tip that others might find handy, please [file an issue]({{ site.repository }}/issues/new) and we’ll see about adding it to the guide.