jekyll/docs/_docs/variables.md

57 lines
1.8 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
title: Variables
permalink: /docs/variables/
---
Jekyll traverses your site looking for files to process. Any files with
[front matter](/docs/front-matter/) are subject to processing. For each of these
files, Jekyll makes a variety of data available via [Liquid](/docs/liquid/).
The following is a reference of the available data.
## Global Variables
{% include docs_variables_table.html scope=site.data.jekyll_variables.global %}
## Site Variables
{% include docs_variables_table.html scope=site.data.jekyll_variables.site %}
## Page Variables
{% include docs_variables_table.html scope=site.data.jekyll_variables.page %}
<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 pages 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 layouts front matter,
that value will be available as <code>layout.class</code> in the layout and its parents.
</p>
</div>
## Jekyll Variables
{% include docs_variables_table.html scope=site.data.jekyll_variables.jekyll %}
## Theme Variables {%- include docs_version_badge.html version="4.3.0" -%}
{: #theme-variables }
{% include docs_variables_table.html scope=site.data.jekyll_variables.theme %}
## Paginator
{% include docs_variables_table.html scope=site.data.jekyll_variables.paginator %}
<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>.
</p>
</div>