_config.yml. See below for details.
+ Site wide information + configuration settings from _config.yml.
+ See below for details.
- name: page
description: >-
- Page specific information + the front
- matter. Custom variables set via the front matter will be
- available here. See below for details.
+ Page specific information + the front matter.
+ Custom variables set via the front matter will be available here. See below for details.
- name: layout
description: >-
- Layout specific information + the front
- matter. Custom variables set via front matter in
- layouts will be available here.
+ Layout specific information + the front matter.
+ Custom variables set via front matter in layouts will be available here.
- name: content
description: >-
In layout files, the rendered content of the Post or Page being wrapped.
Not defined in Post or Page files.
- name: paginator
description: >-
- When the paginate configuration option is set, this
- variable becomes available for use. See Pagination for details.
+ When the paginate configuration option is set, this variable becomes available
+ for use. See Pagination for details.
site:
- name: site.time
@@ -35,15 +32,18 @@ site:
A reverse chronological list of all Posts.
- name: site.related_posts
description: >-
- If the page being processed is a Post, this contains a list of up to ten
- related Posts. By default, these are the ten most recent posts.
- For high quality but slow to compute results, run the
- jekyll command with the --lsi (latent semantic indexing) option. Also note GitHub Pages does not support the lsi option when generating sites.
+ If the page being processed is a Post, this contains a list of up to ten related Posts.
+ By default, these are the ten most recent posts. For high quality but slow to compute
+ results, run the jekyll command with the --lsi
+ (latent semantic indexing)
+ option. Also note GitHub Pages does not support the
+ lsi option when generating sites.
- name: site.static_files
description: >-
A list of all static files (i.e.
files not processed by Jekyll's converters or the Liquid renderer).
- Each file has five properties: path, modified_time, name, basename and extname.
+ Each file has five properties: path, modified_time,
+ name, basename and extname.
- name: site.html_pages
description: >-
A subset of `site.pages` listing those which end in `.html`.
@@ -55,7 +55,8 @@ site:
A list of all the collections (including posts).
- name: site.data
description: >-
- A list containing the data loaded from the YAML files located in the _data directory.
+ A list containing the data loaded from the YAML files located in the _data
+ directory.
- name: site.documents
description: >-
A list of all the documents in every collection.
@@ -68,20 +69,17 @@ site:
- name: site.url
description: >-
Contains the url of your site as it is configured in the _config.yml.
- For example, if you have url: http://mysite.com
- in your configuration file, then it will be accessible in Liquid as
- site.url. For the development environment there is
- an exception,
- if you are running jekyll serve in a development environment
- site.url will be set to the value of host,
- port, and SSL-related options. This defaults to
- url: http://localhost:4000.
- - name: site.[CONFIGURATION_DATA]
+ For example, if you have url: http://mysite.com in your configuration file,
+ then it will be accessible in Liquid as site.url. For the development
+ environment there is an
+ exception, if you are running jekyll serve in a development environment
+ site.url will be set to the value of host, port,
+ and SSL-related options. This defaults to url: http://localhost:4000.
+ - name: "site.[CONFIGURATION_DATA]"
description: >-
- All the variables set via the command line and your
- _config.yml are available through the site
- variable. For example, if you have foo: bar
- in your configuration file, then it will be accessible in Liquid as site.foo.
+ All the variables set via the command line and your _config.yml are available
+ through the site variable. For example, if you have foo: bar in
+ your configuration file, then it will be accessible in Liquid as site.foo.
Jekyll does not parse changes to _config.yml in
watch mode, you must restart Jekyll to see changes to variables.
@@ -98,46 +96,41 @@ page:
The un-rendered excerpt of a document.
- name: page.url
description: >-
- The URL of the Post without the domain, but
- with a leading slash, e.g.
+ The URL of the Post without the domain, but with a leading slash, e.g.
/2008/12/14/my-post.html
- name: page.date
description: >-
- The Date assigned to the Post. This can be overridden in a Post’s front
- matter by specifying a new date/time in the format
- YYYY-MM-DD HH:MM:SS (assuming UTC), or
- YYYY-MM-DD HH:MM:SS +/-TTTT (to specify a time zone using
- an offset from UTC. e.g. 2008-12-14 10:30:00 +0900).
+ The Date assigned to the Post. This can be overridden in a Post’s front matter by specifying
+ a new date/time in the format YYYY-MM-DD HH:MM:SS (assuming UTC), or
+ YYYY-MM-DD HH:MM:SS +/-TTTT (to specify a time zone using an offset from UTC.
+ e.g. 2008-12-14 10:30:00 +0900).
- name: page.id
description: >-
An identifier unique to a document in a Collection or a Post (useful in RSS feeds). e.g.
- /2008/12/14/my-post
- /my-collection/my-document
+ /2008/12/14/my-post/my-collection/my-document
- name: page.categories
description: >-
- The list of categories to which this post belongs. Categories are
- derived from the directory structure above the _posts
- directory. For example, a post at
- /work/code/_posts/2008-12-24-closures.md would have this
- field set to ['work', 'code']. These can also be specified
- in the front matter.
+ The list of categories to which this post belongs. Categories are derived from the directory
+ structure above the _posts directory. For example, a post at
+ /work/code/_posts/2008-12-24-closures.md would have this field set to
+ ['work', 'code']. These can also be specified in the
+ front matter.
- name: page.tags
description: >-
- The list of tags to which this post belongs. These can be specified in
- the front matter.
+ The list of tags to which this post belongs. These can be specified in the
+ front matter.
- name: page.path
description: >-
- The path to the raw post or page. Example usage: Linking back to the
- page or post’s source on GitHub. This can be overridden in the
- front matter.
+ The path to the raw post or page. Example usage: Linking back to the page or post’s source
+ on GitHub. This can be overridden in the front matter.
- name: page.next
description: >-
- The next post relative to the position of the current post in
- site.posts. Returns nil for the last entry.
+ The next post relative to the position of the current post in site.posts.
+ Returns nil for the last entry.
- name: page.previous
description: >-
- The previous post relative to the position of the current post in
- site.posts. Returns nil for the first entry.
+ The previous post relative to the position of the current post in site.posts.
+ Returns nil for the first entry.
paginator:
- name: paginator.per_page
diff --git a/docs/_docs/variables.md b/docs/_docs/variables.md
index 3ffcfb5d..aabec18d 100644
--- a/docs/_docs/variables.md
+++ b/docs/_docs/variables.md
@@ -22,9 +22,7 @@ The following is a reference of the available data.
{% for var in site.data.jekyll_variables.global %}
{{ var.name }}
{{- var.description -}}
-{{- var.description -}}
{{ var.name }}
{{- var.description -}}
-{{- var.description -}}
{{ var.name }}
{{- var.description -}}
-{{- var.description -}}
-
Any custom front matter that you specify will be available under
page. For example, if you specify custom_css: true
- in a page’s front matter, that value will be available as
- page.custom_css.
-
+ in a page’s front matter, that value will be available as page.custom_css.
-
If you specify front matter in a layout, access that via layout.
- For example, if you specify class: full_page
- in a layout’s front matter, that value will be available as
- layout.class in the layout and its parents.
-
+ For example, if you specify class: full_page in a layout’s front matter,
+ that value will be available as layout.class in the layout and its parents.
-
- These are only available in index files, however they can be located in a
- subdirectory, such as /blog/index.html.
-
+ These are only available in index files, however they can be located in a subdirectory,
+ such as /blog/index.html.