Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update index.md #6933

Merged
merged 4 commits into from Apr 18, 2018
Merged

Update index.md #6933

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
43eb51d
Update index.md
Awjin Apr 17, 2018
e5920fc
Remove extra quotes in front matter
Awjin Apr 17, 2018
1d3577a
Revert intro to paragraph form for better flow
Awjin Apr 17, 2018
60a8f73
Revert to original intro sentence
Awjin Apr 18, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
59 changes: 22 additions & 37 deletions docs/_docs/index.md
View file
Open in desktop
Expand Up @@ -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.

## 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
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
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel like this explanation makes total sense to someone who uses Jekyll, but to a newcomer it might feel dense. There's a lot of moving parts, with no room between the commas for the weight of each part to sink in. Thoughts?

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**.

## Helpful Hints

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.
This site is 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"...aims to be a comprehensive guide to Jekyll." I think the current "Docs" homepage used this phrasing as well.

Let's not get ahead of ourselves here 😉


## What is Jekyll, exactly?

Jekyll is a simple, blog-aware, static site generator.

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.

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:

<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>
<h5>ProTips™</h5>
<p>Tips and tricks that'll make you 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>
<h5>Notes</h5>
<p>Extra tidbits that are 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>
<h5>Warnings</h5>
<p>Common pitfalls to avoid.</p>
</div>

<div class="note unreleased">
<h5>You'll see this by a feature that hasn't been released</h5>
<p>Some pieces of this website are for future versions of Jekyll that
are not yet released.</p>
<h5>Unreleased</h5>
<p>Features planned for future versions of Jekyll, but not available yet.</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]({{ 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.