42 lines
1.7 KiB
Markdown
42 lines
1.7 KiB
Markdown
---
|
||
title: Welcome
|
||
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 content, customizing your build, and deploying.
|
||
|
||
## 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™</h5>
|
||
<p>Tips and tricks that'll make you a Jekyll wizard!</p>
|
||
</div>
|
||
|
||
<div class="note info">
|
||
<h5>Notes</h5>
|
||
<p>Extra tidbits that are sometimes necessary to understand Jekyll.</p>
|
||
</div>
|
||
|
||
<div class="note warning">
|
||
<h5>Warnings</h5>
|
||
<p>Common pitfalls to avoid.</p>
|
||
</div>
|
||
|
||
<div class="note unreleased">
|
||
<h5>Unreleased</h5>
|
||
<p>Features planned for future versions of Jekyll, but not available yet.</p>
|
||
</div>
|
||
|
||
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.
|