dan
/
jekyll
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Adjust whitespace

This commit is contained in:
Ashwin Maroli 2018-10-24 19:21:30 +05:30
parent a7a9c52ae6
commit 75f1bccaa4
2 changed files with 55 additions and 76 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

101
docs/_data/jekyll_variables.yml
View File

@ -1,27 +1,24 @@
global:
- name: site
description: >-
Site wide information + configuration settings from
<code>_config.yml</code>. See below for details.
Site wide information + configuration settings from <code>_config.yml</code>.
See below for details.
- name: page
description: >-
Page specific information + the <a href="/docs/front-matter/">front
matter</a>. Custom variables set via the front matter will be
available here. See below for details.
Page specific information + the <a href="/docs/front-matter/">front matter</a>.
Custom variables set via the front matter will be available here. See below for details.
- name: layout
description: >-
Layout specific information + the <a href="/docs/front-matter/">front
matter</a>. Custom variables set via front matter in
layouts will be available here.
Layout specific information + the <a href="/docs/front-matter/">front matter</a>.
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 <code>paginate</code> configuration option is set, this
variable becomes available for use. See <a
href="../pagination/">Pagination</a> for details.
When the <code>paginate</code> configuration option is set, this variable becomes available
for use. See <a href="../pagination/">Pagination</a> 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
<code>jekyll</code> command with the <code>--lsi</code> (<a href="https://en.wikipedia.org/wiki/Latent_semantic_analysis#Latent_semantic_indexing">latent semantic indexing</a>) option. Also note GitHub Pages does not support the <code>lsi</code> 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 <code>jekyll</code> command with the <code>--lsi</code>
(<a href="https://en.wikipedia.org/wiki/Latent_semantic_analysis#Latent_semantic_indexing">latent semantic indexing</a>)
option. Also note GitHub Pages does not support the
<code>lsi</code> option when generating sites.
- name: site.static_files
description: >-
A list of all <a href="/docs/static-files/">static files</a> (i.e.
files not processed by Jekyll's converters or the Liquid renderer).
Each file has five properties: <code>path</code>, <code>modified_time</code>, <code>name</code>, <code>basename</code> and <code>extname</code>.
Each file has five properties: <code>path</code>, <code>modified_time</code>,
<code>name</code>, <code>basename</code> and <code>extname</code>.
- 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 <code>_data</code> directory.
A list containing the data loaded from the YAML files located in the <code>_data</code>
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 <code>_config.yml</code>.
For example, if you have <code>url: http://mysite.com</code>
in your configuration file, then it will be accessible in Liquid as
<code>site.url</code>. For the development environment there is
<a href="/news/#3-siteurl-is-set-by-the-development-server">an exception</a>,
if you are running <code>jekyll serve</code> in a development environment
<code>site.url</code> will be set to the value of <code>host</code>,
<code>port</code>, and SSL-related options. This defaults to
<code>url: http://localhost:4000</code>.
- name: site.[CONFIGURATION_DATA]
For example, if you have <code>url: http://mysite.com</code> in your configuration file,
then it will be accessible in Liquid as <code>site.url</code>. For the development
environment there is <a href="/news/#3-siteurl-is-set-by-the-development-server">an
exception</a>, if you are running <code>jekyll serve</code> in a development environment
<code>site.url</code> will be set to the value of <code>host</code>, <code>port</code>,
and SSL-related options. This defaults to <code>url: http://localhost:4000</code>.
- name: "site.[CONFIGURATION_DATA]"
description: >-
All the variables set via the command line and your
<code>_config.yml</code> are available through the <code>site</code>
variable. For example, if you have <code>foo: bar</code>
in your configuration file, then it will be accessible in Liquid as <code>site.foo</code>.
All the variables set via the command line and your <code>_config.yml</code> are available
through the <code>site</code> variable. For example, if you have <code>foo: bar</code> in
your configuration file, then it will be accessible in Liquid as <code>site.foo</code>.
Jekyll does not parse changes to <code>_config.yml</code> in
<code>watch</code> 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.
<code>/2008/12/14/my-post.html</code>
- 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
<code>YYYY-MM-DD HH:MM:SS</code> (assuming UTC), or
<code>YYYY-MM-DD HH:MM:SS +/-TTTT</code> (to specify a time zone using
an offset from UTC. e.g. <code>2008-12-14 10:30:00 +0900</code>).
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 <code>YYYY-MM-DD HH:MM:SS</code> (assuming UTC), or
<code>YYYY-MM-DD HH:MM:SS +/-TTTT</code> (to specify a time zone using an offset from UTC.
e.g. <code>2008-12-14 10:30:00 +0900</code>).
- name: page.id
description: >-
An identifier unique to a document in a Collection or a Post (useful in RSS feeds). e.g.
<code>/2008/12/14/my-post</code>
<code>/my-collection/my-document</code>
<code>/2008/12/14/my-post</code><code>/my-collection/my-document</code>
- name: page.categories
description: >-
The list of categories to which this post belongs. Categories are
derived from the directory structure above the <code>_posts</code>
directory. For example, a post at
<code>/work/code/_posts/2008-12-24-closures.md</code> would have this
field set to <code>['work', 'code']</code>. These can also be specified
in the <a href="/docs/front-matter/">front matter</a>.
The list of categories to which this post belongs. Categories are derived from the directory
structure above the <code>_posts</code> directory. For example, a post at
<code>/work/code/_posts/2008-12-24-closures.md</code> would have this field set to
<code>['work', 'code']</code>. These can also be specified in the
<a href="/docs/front-matter/">front matter</a>.
- name: page.tags
description: >-
The list of tags to which this post belongs. These can be specified in
the <a href="/docs/front-matter/">front matter</a>.
The list of tags to which this post belongs. These can be specified in the
<a href="/docs/front-matter/">front matter</a>.
- 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
<a href="/docs/front-matter/">front matter</a>.
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 <a href="/docs/front-matter/">front matter</a>.
- name: page.next
description: >-
The next post relative to the position of the current post in
<code>site.posts</code>. Returns <code>nil</code> for the last entry.
The next post relative to the position of the current post in <code>site.posts</code>.
Returns <code>nil</code> for the last entry.
- name: page.previous
description: >-
The previous post relative to the position of the current post in
<code>site.posts</code>. Returns <code>nil</code> for the first entry.
The previous post relative to the position of the current post in <code>site.posts</code>.
Returns <code>nil</code> for the first entry.
paginator:
- name: paginator.per_page

30
docs/_docs/variables.md
View File

@ -22,9 +22,7 @@ The following is a reference of the available data.
{% for var in site.data.jekyll_variables.global %}
<tr>
<td><p><code>{{ var.name }}</code></p></td>
<td>
<p>{{- var.description -}}</p>
</td>
<td><p>{{- var.description -}}</p></td>
</tr>
{% endfor %}
</tbody>
@ -45,9 +43,7 @@ The following is a reference of the available data.
{% for var in site.data.jekyll_variables.site %}
<tr>
<td><p><code>{{ var.name }}</code></p></td>
<td>
<p>{{- var.description -}}</p>
</td>
<td><p>{{- var.description -}}</p></td>
</tr>
{% endfor %}
</tbody>
@ -68,9 +64,7 @@ The following is a reference of the available data.
{% for var in site.data.jekyll_variables.page %}
<tr>
<td><p><code>{{ var.name }}</code></p></td>
<td>
<p>{{- var.description -}}</p>
</td>
<td><p>{{- var.description -}}</p></td>
</tr>
{% endfor %}
</tbody>
@ -80,20 +74,14 @@ The following is a reference of the available data.
<div class="note">
<h5>ProTip™: Use Custom Front Matter</h5>
<p>
Any custom front matter that you specify will be available under
<code>page</code>. For example, if you specify <code>custom_css: true</code>
in a page’s front matter, that value will be available as
<code>page.custom_css</code>.
in a page’s front matter, that value will be available as <code>page.custom_css</code>.
</p>
<p>
If you specify front matter in a layout, access that via <code>layout</code>.
For example, if you specify <code>class: full_page</code>
in a layout’s front matter, that value will be available as
<code>layout.class</code> in the layout and its parents.
For example, if you specify <code>class: full_page</code> in a layout’s front matter,
that value will be available as <code>layout.class</code> in the layout and its parents.
</p>
</div>
@ -121,9 +109,7 @@ The following is a reference of the available data.
<div class="note info">
<h5>Paginator variable availability</h5>
<p>
These are only available in index files, however they can be located in a
subdirectory, such as <code>/blog/index.html</code>.
These are only available in index files, however they can be located in a subdirectory,
such as <code>/blog/index.html</code>.
</p>
</div>