update directory structure documentation
This commit is contained in:
parent
15bdd81499
commit
5d1f2bceea
|
@ -40,16 +40,13 @@ A basic Jekyll site usually looks something like this:
|
||||||
```
|
```
|
||||||
|
|
||||||
<div class="note info">
|
<div class="note info">
|
||||||
<h5>Directory Structure of Jekyll Sites using Theme Gems</h5>
|
<h5>Directory structure of Jekyll sites using gem themes</h5>
|
||||||
<p>
|
<p>
|
||||||
Starting <strong><em>v3.2</em></strong>, a new Jekyll Project installed by <code>jekyll new</code> uses gem-based themes to define the look of the site, and would have a slightly changed directory structure. <br><code>_layouts</code>, <code>_includes</code> and <code>_sass</code> are now part of the gem-based theme, which by default, is <em><a href="https://github.com/jekyll/minima">minima</a>.</em>
|
Starting <strong>Jekyll 3.2</strong>, a new Jekyll project boostraped with <code>jekyll new</code> uses <a href="../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 by default in the gem theme path.
|
||||||
</p>
|
</p>
|
||||||
|
<br />
|
||||||
<p>
|
<p>
|
||||||
With <strong><em>v3.3</em></strong>, the <code>css</code> directory has been renamed to <code>assets</code>, and moved to <em>minima</em> as well. Moreover, <code>index.html</code> is now an <code>index.md</code>.
|
<a href="https://github.com/jekyll/minima">minima</a> is the current default theme, <code>bundle show minima</code> will show you where minima theme's files are stored on your computer.
|
||||||
</p><br>
|
|
||||||
<p>
|
|
||||||
You can easily find the path to your local installation of minima gem by executing <code>bundle show minima</code>.
|
|
||||||
For further information, refer <a href="../themes/">our documentation on theme-gems</a>.
|
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
@ -70,11 +67,9 @@ An overview of what each of these does:
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
<p>
|
<p>
|
||||||
|
|
||||||
Stores <a href="../configuration/">configuration</a> data. Many of
|
Stores <a href="../configuration/">configuration</a> data. Many of
|
||||||
these options can be specified from the command line executable but
|
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.
|
it’s easier to specify them here so you don’t have to remember them.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
@ -84,11 +79,9 @@ An overview of what each of these does:
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
<p>
|
<p>
|
||||||
|
|
||||||
Drafts are unpublished posts. The format of these files is without a
|
Drafts are unpublished posts. The format of these files is without a
|
||||||
date: <code>title.MARKUP</code>. Learn how to <a href="../drafts/">
|
date: <code>title.MARKUP</code>. Learn how to <a href="../drafts/">
|
||||||
work with drafts</a>.
|
work with drafts</a>.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
@ -98,13 +91,11 @@ An overview of what each of these does:
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
<p>
|
<p>
|
||||||
|
|
||||||
These are the partials that can be mixed and matched by your layouts
|
These are the partials that can be mixed and matched by your layouts
|
||||||
and posts to facilitate reuse. The liquid tag
|
and posts to facilitate reuse. The liquid tag
|
||||||
<code>{% raw %}{% include file.ext %}{% endraw %}</code>
|
<code>{% raw %}{% include file.ext %}{% endraw %}</code>
|
||||||
can be used to include the partial in
|
can be used to include the partial in
|
||||||
<code>_includes/file.ext</code>.
|
<code>_includes/file.ext</code>.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
@ -114,14 +105,12 @@ An overview of what each of these does:
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
<p>
|
<p>
|
||||||
|
|
||||||
These are the templates that wrap posts. Layouts are chosen on a
|
These are the templates that wrap posts. Layouts are chosen on a
|
||||||
post-by-post basis in the
|
post-by-post basis in the
|
||||||
<a href="../frontmatter/">YAML Front Matter</a>,
|
<a href="../frontmatter/">YAML Front Matter</a>,
|
||||||
which is described in the next section. The liquid tag
|
which is described in the next section. The liquid tag
|
||||||
<code>{% raw %}{{ content }}{% endraw %}</code>
|
<code>{% raw %}{{ content }}{% endraw %}</code>
|
||||||
is used to inject content into the web page.
|
is used to inject content into the web page.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
@ -131,14 +120,12 @@ An overview of what each of these does:
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
<p>
|
<p>
|
||||||
|
|
||||||
Your dynamic content, so to speak. The naming convention of these
|
Your dynamic content, so to speak. The naming convention of these
|
||||||
files is important, and must follow the format:
|
files is important, and must follow the format:
|
||||||
<code>YEAR-MONTH-DAY-title.MARKUP</code>.
|
<code>YEAR-MONTH-DAY-title.MARKUP</code>.
|
||||||
The <a href="../permalinks/">permalinks</a> can be customized for
|
The <a href="../permalinks/">permalinks</a> can be customized for
|
||||||
each post, but the date and markup language are determined solely by
|
each post, but the date and markup language are determined solely by
|
||||||
the file name.
|
the file name.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
@ -148,7 +135,6 @@ An overview of what each of these does:
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
<p>
|
<p>
|
||||||
|
|
||||||
Well-formatted site data should be placed here. The Jekyll engine
|
Well-formatted site data should be placed here. The Jekyll engine
|
||||||
will autoload all data files (using either the <code>.yml</code>,
|
will autoload all data files (using either the <code>.yml</code>,
|
||||||
<code>.yaml</code>, <code>.json</code> or <code>.csv</code>
|
<code>.yaml</code>, <code>.json</code> or <code>.csv</code>
|
||||||
|
@ -156,7 +142,6 @@ An overview of what each of these does:
|
||||||
accessible via `site.data`. If there's a file
|
accessible via `site.data`. If there's a file
|
||||||
<code>members.yml</code> under the directory, then you can access
|
<code>members.yml</code> under the directory, then you can access
|
||||||
contents of the file through <code>site.data.members</code>.
|
contents of the file through <code>site.data.members</code>.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
@ -166,11 +151,10 @@ An overview of what each of these does:
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
<p>
|
<p>
|
||||||
|
|
||||||
These are sass partials that can be imported into your <code>main.scss</code>
|
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>
|
which will then be processed into a single stylesheet
|
||||||
|
<code>main.css</code>
|
||||||
that defines the styles to be used by your site.
|
that defines the styles to be used by your site.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
@ -180,11 +164,9 @@ An overview of what each of these does:
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
<p>
|
<p>
|
||||||
|
|
||||||
This is where the generated site will be placed (by default) once
|
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
|
Jekyll is done transforming it. It’s probably a good idea to add this
|
||||||
to your <code>.gitignore</code> file.
|
to your <code>.gitignore</code> file.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
@ -194,13 +176,11 @@ An overview of what each of these does:
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
<p>
|
<p>
|
||||||
|
|
||||||
This helps Jekyll keep track of which files have not been modified
|
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
|
since the site was last built, and which files will need to be
|
||||||
regenerated on the next build. This file will not be included in the
|
regenerated on the next build. This file will not be included in the
|
||||||
generated site. It’s probably a good idea to add this to your
|
generated site. It’s probably a good idea to add this to your
|
||||||
<code>.gitignore</code> file.
|
<code>.gitignore</code> file.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
@ -210,13 +190,11 @@ An overview of what each of these does:
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
<p>
|
<p>
|
||||||
|
|
||||||
Provided that the file has a <a href="../frontmatter/">YAML Front
|
Provided that the file has a <a href="../frontmatter/">YAML Front
|
||||||
Matter</a> section, it will be transformed by Jekyll. The same will
|
Matter</a> section, it will be transformed by Jekyll. The same will
|
||||||
happen for any <code>.html</code>, <code>.markdown</code>,
|
happen for any <code>.html</code>, <code>.markdown</code>,
|
||||||
<code>.md</code>, or <code>.textile</code> file in your site’s root
|
<code>.md</code>, or <code>.textile</code> file in your site’s root
|
||||||
directory or directories not listed above.
|
directory or directories not listed above.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
@ -226,14 +204,12 @@ An overview of what each of these does:
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
<p>
|
<p>
|
||||||
|
|
||||||
Every other directory and file except for those listed above—such as
|
Every other directory and file except for those listed above—such as
|
||||||
<code>css</code> and <code>images</code> folders,
|
<code>css</code> and <code>images</code> folders,
|
||||||
<code>favicon.ico</code> files, and so forth—will be copied verbatim
|
<code>favicon.ico</code> files, and so forth—will be copied verbatim
|
||||||
to the generated site. There are plenty of <a href="../sites/">sites
|
to the generated site. There are plenty of <a href="../sites/">sites
|
||||||
already using Jekyll</a> if you’re curious to see how they’re laid
|
already using Jekyll</a> if you’re curious to see how they’re laid
|
||||||
out.
|
out.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
Loading…
Reference in New Issue