diff --git a/docs/_docs/structure.md b/docs/_docs/structure.md index 0d205361..cbc8b6ee 100644 --- a/docs/_docs/structure.md +++ b/docs/_docs/structure.md @@ -40,16 +40,13 @@ A basic Jekyll site usually looks something like this: ```
- Starting v3.2, a new Jekyll Project installed by jekyll new
uses gem-based themes to define the look of the site, and would have a slightly changed directory structure. _layouts
, _includes
and _sass
are now part of the gem-based theme, which by default, is minima.
+ Starting Jekyll 3.2, a new Jekyll project boostraped 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 by default in the gem theme path.
- With v3.3, the css
directory has been renamed to assets
, and moved to minima as well. Moreover, index.html
is now an index.md
.
-
- You can easily find the path to your local installation of minima gem by executing bundle show minima
.
- For further information, refer our documentation on theme-gems.
+ minima is the current default theme, bundle show minima
will show you where minima theme's files are stored on your computer.
- 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: title.MARKUP
. Learn how to
work with drafts.
-
-
These are the partials that can be mixed and matched by your layouts
and posts to facilitate reuse. The liquid tag
{% raw %}{% include file.ext %}{% endraw %}
can be used to include the partial in
_includes/file.ext
.
-
-
These are the templates that wrap posts. Layouts are chosen on a
post-by-post basis in the
YAML Front Matter,
which is described in the next section. The liquid tag
{% raw %}{{ content }}{% endraw %}
is used to inject content into the web page.
-
-
Your dynamic content, so to speak. The naming convention of these
files is important, and must follow the format:
YEAR-MONTH-DAY-title.MARKUP
.
The permalinks can be customized for
each post, but the date and markup language are determined solely by
the file name.
-
-
Well-formatted site data should be placed here. The Jekyll engine
will autoload all data files (using either the .yml
,
.yaml
, .json
or .csv
@@ -156,7 +142,6 @@ An overview of what each of these does:
accessible via `site.data`. If there's a file
members.yml
under the directory, then you can access
contents of the file through site.data.members
.
-
-
These are sass partials that can be imported into your main.scss
- which will then be processed into a single stylesheet main.css
+ which will then be processed into a single stylesheet
+ main.css
that defines the styles to be used by your site.
-
-
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 .gitignore
file.
-
-
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. This file will not be included in the
generated site. It’s probably a good idea to add this to your
.gitignore
file.
-
-
Provided that the file has a YAML Front
Matter section, it will be transformed by Jekyll. The same will
happen for any .html
, .markdown
,
.md
, or .textile
file in your site’s root
directory or directories not listed above.
-
-
Every other directory and file except for those listed above—such as
css
and images
folders,
favicon.ico
files, and so forth—will be copied verbatim
to the generated site. There are plenty of sites
already using Jekyll if you’re curious to see how they’re laid
out.
-