3.8 KiB
layout | title | prev_section | next_section |
---|---|---|---|
docs | Directory structure | usage | configuration |
Jekyll at its core is a text transformation engine. The concept behind the system is this: you give it text written in your favorite markup language, be that Markdown, Textile, or just plain HTML, and it churns that through a layout or series of layout files. Throughout that process you can tweak how you want the site URLs to look, what data gets displayed on the layout and more. This is all done through strictly editing files, and the web interface is the final product.
A basic Jekyll site usually looks something like this:
{% highlight bash %} . ├── _config.yml ├── _includes | ├── footer.html | └── header.html ├── _layouts | ├── default.html | └── post.html ├── _posts | ├── 2007-10-29-why-every-programmer-should-play-nethack.textile | └── 2009-04-26-barcamp-boston-4-roundup.textile ├── _site └── index.html {% endhighlight %}
An overview of what each of these does:
File / Directory | Description |
---|---|
|
Stores configuration data. A majority of these options can be specified from the command line executable but it’s easier to throw them in here so you don’t have to remember them. |
|
These are the partials that can be mixed and matched by your _layouts and _posts to facilitate reuse. The liquid tag |
|
These are the templates which posts are inserted into. Layouts are chosen on a post-by-post basis in the YAML front matter, which is described in the next section. The liquid tag |
|
Your dynamic content, so to speak. The format of these files is important, as named as |
|
This is where the generated site will be placed once Jekyll is done transforming it. It's probably a good idea to add this to your |
|
Provided that the file has a YAML Front Matter section, it will be transformed by Jekyll. The same will happen for any |
Other Files/Folders |
Every other directory and file except for those listed above—such as |