Directory Structure

A basic Jekyll site usually looks something like this:

<div class="note"> <h5>Directory structure of Jekyll sites using gem-based themes</h5> <p> Since version {% include docs_version_badge.html version="3.2"%}, a new Jekyll project bootstrapped with <code>jekyll new</code> uses <a href="/docs/themes/">gem-based themes</a> to define the look of the site. This results in a lighter default directory structure: <code>_layouts</code>, <code>_includes</code> and <code>_sass</code> are stored in the theme-gem, by default. </p> <p> <a href="https://github.com/jekyll/minima">minima</a> is the current default theme, and <code>bundle info minima</code> will show you where minima theme's files are stored on your computer. </p> </div>

An overview of what each of these does:

<div class="mobile-side-scroller"> <table> <thead> <tr> <th>File / Directory</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td> <p><code>_config.yml</code></p> </td> <td> <p> Stores <a href="/docs/configuration/">configuration</a> 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. </p> </td> </tr> <tr> <td> <p><code>_drafts</code></p> </td> <td> <p> Drafts are unpublished posts. The format of these files is without a date: <code>title.MARKUP</code>. Learn how to <a href="/docs/posts/#drafts"> work with drafts</a>. </p> </td> </tr> <tr> <td> <p><code>_includes</code></p> </td> <td> <p> These are the partials that can be mixed and matched by your layouts and posts to facilitate reuse. The liquid tag <code>{% raw %}{% include file.ext %}{% endraw %}</code> can be used to include the partial in <code>_includes/file.ext</code>. </p> </td> </tr> <tr> <td> <p><code>_layouts</code></p> </td> <td> <p> These are the templates that wrap posts. Layouts are chosen on a post-by-post basis in the <a href="/docs/front-matter/">front matter</a>, which is described in the next section. The liquid tag <code>{% raw %}{{ content }}{% endraw %}</code> is used to inject content into the web page. </p> </td> </tr> <tr> <td> <p><code>_posts</code></p> </td> <td> <p> Your dynamic content, so to speak. The naming convention of these files is important, and must follow the format: <code>YEAR-MONTH-DAY-title.MARKUP</code>. The <a href="/docs/permalinks/">permalinks</a> can be customized for each post, but the date and markup language are determined solely by the file name. </p> </td> </tr> <tr> <td> <p><code>_data</code></p> </td> <td> <p> Well-formatted site data should be placed here. The Jekyll engine will autoload all data files (using either the <code>.yml</code>, <code>.yaml</code>, <code>.json</code>, <code>.csv</code> or <code>.tsv</code> formats and extensions) in this directory, and they will be accessible via `site.data`. If there's a file <code>members.yml</code> under the directory, then you can access contents of the file through <code>site.data.members</code>. </p> </td> </tr> <tr> <td> <p><code>_sass</code></p> </td> <td> <p> These are sass partials that can be imported into your <code>main.scss</code> which will then be processed into a single stylesheet <code>main.css</code> that defines the styles to be used by your site. Learn <a href="{{ '/docs/assets/' | relative_url }}">how to work with assets</a>. </p> </td> </tr> <tr> <td> <p><code>_site</code></p> </td> <td> <p> 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 <code>.gitignore</code> file. </p> </td> </tr> <tr> <td> <p><code>.jekyll-cache</code></p> </td> <td> <p> Keeps a copy of the generated pages and markup (e.g.: markdown) for faster serving. Created when using e.g.: <code>jekyll serve</code>. Can be disabled with <a href="/docs/configuration/options/">an option and/or flag</a>. This directory will not be included in the generated site. It’s probably a good idea to add this to your <code>.gitignore</code> file. </p> </td> </tr> <tr> <td> <p><code>.jekyll-metadata</code></p> </td> <td> <p> 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 <a href="/docs/configuration/incremental-regeneration/"> incremental regeneration</a> (e.g.: with <code>jekyll serve -I</code>). This file will not be included in the generated site. It’s probably a good idea to add this to your <code>.gitignore</code> file. </p> </td> </tr> <tr> <td> <p><code>index.html</code> or <code>index.md</code> and other HTML, Markdown files</p> </td> <td> <p> Provided that the file has a <a href="/docs/front-matter/">front matter</a> section, it will be transformed by Jekyll. The same will happen for any <code>.html</code>, <code>.markdown</code>, <code>.md</code>, or <code>.textile</code> file in your site’s root directory or directories not listed above. </p> </td> </tr> <tr> <td> <p>Other Files/Folders</p> </td> <td> <p> Except for the special cases listed above, every other directory and file—such as <code>css</code> and <code>images</code> folders, <code>favicon.ico</code> files, and so forth—will be copied verbatim to the generated site. There are plenty of <a href="/showcase/">sites already using Jekyll</a> if you’re curious to see how they’re laid out. </p> </td> </tr> </tbody> </table> </div>

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: