diff --git a/docs/_docs/structure.md b/docs/_docs/structure.md index b21cb1b2..0d205361 100644 --- a/docs/_docs/structure.md +++ b/docs/_docs/structure.md @@ -17,6 +17,8 @@ A basic Jekyll site usually looks something like this: ```sh . ├── _config.yml +├── _data +| └── members.yml ├── _drafts | ├── begin-with-the-crazy-ideas.md | └── on-simplicity-in-technology.md @@ -29,13 +31,28 @@ A basic Jekyll site usually looks something like this: ├── _posts | ├── 2007-10-29-why-every-programmer-should-play-nethack.md | └── 2009-04-26-barcamp-boston-4-roundup.md -├── _data -| └── members.yml +├── _sass +| ├── _base.scss +| └── _layout.scss ├── _site ├── .jekyll-metadata -└── index.html +└── index.html # can also be an 'index.md' with valid YAML Frontmatter ``` +
+ 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.
+
+ 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.
+
Well-formatted site data should be placed here. The Jekyll engine
- will autoload all YAML files in this directory (using either the
- .yml
, .yaml
, .json
or
- .csv
formats and extensions) and they will be
+ will autoload all data files (using either the .yml
,
+ .yaml
, .json
or .csv
+ formats and extensions) in this directory, and they will be
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
.
@@ -143,6 +160,20 @@ An overview of what each of these does:
_sass
+
+ These are sass partials that can be imported into your main.scss
+ which will then be processed into a single stylesheet main.css
+ that defines the styles to be used by your site.
+
+
_site
index.html
and other HTML, Markdown, Textile files
index.html
or index.md
and other HTML, Markdown, Textile files