From 15bdd8149913bbf33411711365b385a21e262625 Mon Sep 17 00:00:00 2001 From: Ashwin Maroli Date: Sat, 12 Nov 2016 23:28:57 +0530 Subject: [PATCH 1/3] bring docs on 'structure' up-to-date --- docs/_docs/structure.md | 45 ++++++++++++++++++++++++++++++++++------- 1 file changed, 38 insertions(+), 7 deletions(-) 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 ``` +
+
Directory Structure of Jekyll Sites using Theme Gems
+

+ 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. +

+
+ An overview of what each of these does:
@@ -133,9 +150,9 @@ An overview of what each of these does:

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

@@ -175,7 +206,7 @@ An overview of what each of these does: -

index.html and other HTML, Markdown, Textile files

+

index.html or index.md and other HTML, Markdown, Textile files

From 5d1f2bceeac33f5f48be5eebf805cf18ccc9a929 Mon Sep 17 00:00:00 2001 From: Frank Taillandier Date: Sat, 12 Nov 2016 20:51:55 +0100 Subject: [PATCH 2/3] update directory structure documentation --- docs/_docs/structure.md | 36 ++++++------------------------------ 1 file changed, 6 insertions(+), 30 deletions(-) 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: ```

-
Directory Structure of Jekyll Sites using Theme Gems
+
Directory structure of Jekyll sites using gem themes

- 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.

@@ -70,11 +67,9 @@ An overview of what each of these does:

- 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. -

@@ -84,11 +79,9 @@ An overview of what each of these does:

- Drafts are unpublished posts. The format of these files is without a date: title.MARKUP. Learn how to work with drafts. -

@@ -98,13 +91,11 @@ An overview of what each of these does:

- 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. -

@@ -114,14 +105,12 @@ An overview of what each of these does:

- 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. -

@@ -131,14 +120,12 @@ An overview of what each of these does:

- 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. -

@@ -148,7 +135,6 @@ An overview of what each of these does:

- 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. -

@@ -166,11 +151,10 @@ An overview of what each of these does:

- 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. -

@@ -180,11 +164,9 @@ An overview of what each of these does:

- 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. -

@@ -194,13 +176,11 @@ An overview of what each of these does:

- 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. -

@@ -210,13 +190,11 @@ An overview of what each of these does:

- 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. -

@@ -226,14 +204,12 @@ An overview of what each of these does:

- 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. -

From 365ecb7c37417a983886a25d9523f201dbf9a708 Mon Sep 17 00:00:00 2001 From: Ashwin Maroli Date: Sun, 13 Nov 2016 07:41:50 +0530 Subject: [PATCH 3/3] a few more edits --- docs/_docs/structure.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/_docs/structure.md b/docs/_docs/structure.md index cbc8b6ee..bdfaab59 100644 --- a/docs/_docs/structure.md +++ b/docs/_docs/structure.md @@ -40,13 +40,13 @@ A basic Jekyll site usually looks something like this: ```
-
Directory structure of Jekyll sites using gem themes
+
Directory structure of Jekyll sites using gem-based themes

- 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. + Starting Jekyll 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, bundle show minima will show you where minima theme's files are stored on your computer. + minima is the current default theme, and bundle show minima will show you where minima theme's files are stored on your computer.

@@ -153,8 +153,7 @@ An overview of what each of these does:

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. + main.css that defines the styles to be used by your site.

@@ -186,7 +185,8 @@ An overview of what each of these does: -

index.html or index.md and other HTML, Markdown, Textile files

+

index.html or index.md and other HTML, + Markdown, Textile files