Directory Structure
A basic Jekyll site usually looks something like this:
.
├── _config.yml
├── _data
│ └── members.yml
├── _drafts
│ ├── begin-with-the-crazy-ideas.md
│ └── on-simplicity-in-technology.md
├── _includes
│ ├── footer.html
│ └── header.html
├── _layouts
│ ├── default.html
│ └── post.html
├── _posts
│ ├── 2007-10-29-why-every-programmer-should-play-nethack.md
│ └── 2009-04-26-barcamp-boston-4-roundup.md
├── _sass
│ ├── _base.scss
│ └── _layout.scss
├── _site
├── .jekyll-cache
│ └── Jekyll
│ └── Cache
│ └── [...]
├── .jekyll-metadata
└── index.html # can also be an 'index.md' with valid front matter
Directory structure of Jekyll sites using gem-based themes
Since version 3.2
, a new Jekyll project bootstrapped with jekyll new
uses gem-based themes to define the look of the site. This results in a lighter default directory structure: _layouts
, _includes
and _sass
are stored in the theme-gem, by default.
minima is the current default theme, and bundle info minima
will show you where minima theme's files are stored on your computer.
An overview of what each of these does:
File / Directory | Description |
---|---|
|
Stores configuration data. Many of these options can be specified from the command line executable but it’s easier to specify them here so you don’t have to remember them. |
|
Drafts are unpublished posts. The format of these files is without a
date: |
|
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 that wrap posts. Layouts are chosen on a
post-by-post basis in the
front matter,
which is described in the next section. The liquid tag
|
|
Your dynamic content, so to speak. The naming convention of these
files is important, and must follow the format:
|
|
Well-formatted site data should be placed here. The Jekyll engine
will autoload all data files (using either the |
|
These are sass partials that can be imported into your |
|
This is where the generated site will be placed (by default) once
Jekyll is done transforming it. It’s probably a good idea to add this
to your |
|
Keeps a copy of the generated pages and markup (e.g.: markdown) for
faster serving. Created when using e.g.: |
|
This helps Jekyll keep track of which files have not been modified
since the site was last built, and which files will need to be
regenerated on the next build. Only created when using
incremental regeneration (e.g.: with |
|
Provided that the file has a front
matter section, it will be transformed by Jekyll. The same will
happen for any |
Other Files/Folders |
Except for the special cases listed above, every other directory and
file—such as |
Every file or directory beginning with the following characters: .
, _
, #
or ~
in the source
directory will not be included in the destination
folder. Such paths will have to be explicitly specified via the config file in the include
directive to make sure they’re copied over:
include:
- _pages
- .htaccess