Merge pull request #2674 from kleinfreund/master
This commit is contained in:
Parker Moore
commit
b63d113fe0
|
|
@ -89,7 +89,7 @@
|
|||
* Upgrade listen to `2.7.6 <= x < 3.0.0` (#2492)
|
||||
* Allow configuration of different Twitter and GitHub usernames in site template (#2485)
|
||||
* Bump Pygments to v0.6.0 (#2504)
|
||||
* Front-matter defaults for documents in collections (#2419)
|
||||
* Front matter defaults for documents in collections (#2419)
|
||||
* Include files with a url which ends in `/` in the `site.html_pages` list (#2524)
|
||||
* Make `highlight` tag use `language-` prefix in CSS class (#2511)
|
||||
* Lookup item property via `item#to_liquid` before `#data` or `#[]` in filters (#2493)
|
||||
|
|
@ -107,7 +107,7 @@
|
|||
* Prevent code from overflowing container in site template (#2429)
|
||||
* Encode URLs in UTF-8 when escaping and unescaping (#2420)
|
||||
* No Layouts or Liquid for Asset Files (#2431)
|
||||
* Allow front-matter defaults to set post categories (#2373)
|
||||
* Allow front matter defaults to set post categories (#2373)
|
||||
* Fix command in subcommand deprecation warning (#2457)
|
||||
* Keep all parent directories of files/dirs in `keep_files` (#2458)
|
||||
* When using RedCarpet and Rouge without Rouge installed, fixed erroneous
|
||||
|
|
@ -140,7 +140,7 @@
|
|||
* Prevent table from extending parent width in permalink style table (#2424)
|
||||
* Add collections to info about pagination support (#2389)
|
||||
* Add `jekyll_github_sample` plugin to list of third-party plugins (#2463)
|
||||
* Clarify documentation around front-matter defaults and add details
|
||||
* Clarify documentation around front matter defaults and add details
|
||||
about defaults for collections. (#2439)
|
||||
* Add Jekyll Project Version Tag to list of third-party plugins (#2468)
|
||||
* Use `https` for GitHub links across whole site (#2470)
|
||||
|
|
@ -175,7 +175,7 @@
|
|||
* Update docs to reflect new `baseurl` default (#2341)
|
||||
* Add links to headers who have an ID. (#2342)
|
||||
* Use symbol instead of HTML number in `upgrading.md` (#2351)
|
||||
* Fix link to frontmatter defaults docs (#2353)
|
||||
* Fix link to front matter defaults docs (#2353)
|
||||
* Fix for `History.markdown` in order to fix history page in docs (#2363)
|
||||
|
||||
## 2.0.2 / 2014-05-07
|
||||
|
|
@ -215,7 +215,7 @@
|
|||
* Expose `site.static_files` to Liquid (#2075)
|
||||
* Complete redesign of the template site generated by `jekyll new` (#2050)
|
||||
* Update Listen from 1.x to 2.x (#2097)
|
||||
* Front-matter defaults (#2205)
|
||||
* Front matter defaults (#2205)
|
||||
* Deprecate `relative_permalinks` configuration option (default to `false`) (#2307)
|
||||
* Exclude files based on prefix as well as `fnmatch?` (#2303)
|
||||
|
||||
|
|
@ -260,7 +260,7 @@
|
|||
* Permit YAML blocks to end with three dots to better conform with the
|
||||
YAML spec (#2110)
|
||||
* Use `File.exist?` instead of deprecated `File.exists?` (#2214)
|
||||
* Require newline after start of YAML front-matter header (#2211)
|
||||
* Require newline after start of YAML Front Matter header (#2211)
|
||||
* Add the ability for pages to be marked as `published: false` (#1492)
|
||||
* Add `Jekyll::LiquidExtensions` with `.lookup_variable` method for easy
|
||||
looking up of variable values in a Liquid context. (#2253)
|
||||
|
|
@ -933,7 +933,7 @@
|
|||
* Bullet-proof `limit_posts` option (#1004)
|
||||
* Read in YAML as UTF-8 to accept non-ASCII chars (#836)
|
||||
* Fix the CLI option `--plugins` to actually accept dirs and files (#993)
|
||||
* Allow 'excerpt' in YAML Front-Matter to override the extracted excerpt (#946)
|
||||
* Allow 'excerpt' in YAML front matter to override the extracted excerpt (#946)
|
||||
* Fix cascade problem with site.baseurl, site.port and site.host. (#935)
|
||||
* Filter out directories with valid post names (#875)
|
||||
* Fix symlinked static files not being correctly built in unsafe mode (#909)
|
||||
|
|
@ -945,7 +945,7 @@
|
|||
* Patch for multibyte URI problem with `jekyll serve` (#723)
|
||||
* Order plugin execution by priority (#864)
|
||||
* Fixed Page#dir and Page#url for edge cases (#536)
|
||||
* Fix broken `post_url` with posts with a time in their YAML Front-Matter (#831)
|
||||
* Fix broken `post_url` with posts with a time in their YAML front matter (#831)
|
||||
* Look for plugins under the source directory (#654)
|
||||
* Tumblr Migrator: finds `_posts` dir correctly, fixes truncation of long
|
||||
post names (#775)
|
||||
|
|
@ -1004,7 +1004,7 @@
|
|||
* Fix error with `limit_posts` (#442)
|
||||
* Properly select dotfile during directory scan (#363, #431, #377)
|
||||
* Allow setting of Kramdown `smart_quotes` (#482)
|
||||
* Ensure front-matter is at start of file (#562)
|
||||
* Ensure front matter is at start of file (#562)
|
||||
|
||||
## 0.11.2 / 2011-12-27
|
||||
* Bug Fixes
|
||||
|
|
@ -1125,7 +1125,7 @@
|
|||
## 0.5.6 / 2010-01-08
|
||||
* Bug Fixes
|
||||
* Require redcloth >= 4.2.1 in tests (#92)
|
||||
* Don't break on triple dashes in yaml frontmatter (#93)
|
||||
* Don't break on triple dashes in yaml front matter (#93)
|
||||
|
||||
### Minor Enhancements
|
||||
* Allow .mkd as markdown extension
|
||||
|
|
@ -1173,7 +1173,7 @@
|
|||
(@eugenebolshakov)
|
||||
* Bad markdown processor in config fails sooner and with better message
|
||||
(@ gcnovus)
|
||||
* Allow CRLFs in yaml frontmatter (@juretta)
|
||||
* Allow CRLFs in yaml front matter (@juretta)
|
||||
* Added Date#xmlschema for Ruby versions < 1.9
|
||||
|
||||
## 0.5.1 / 2009-05-06
|
||||
|
|
|
|||
|
|
@ -47,7 +47,7 @@ The Sass converter will default the `sass_dir` configuration option to
|
|||
|
||||
Note that the `sass_dir` becomes the load path for Sass imports,
|
||||
nothing more. This means that Jekyll does not know about these files
|
||||
directly, so any files here should not contain the YAML front matter as
|
||||
directly, so any files here should not contain the YAML Front Matter as
|
||||
described above nor will they be transformed as described above. This
|
||||
folder should only contain imports.
|
||||
|
||||
|
|
|
|||
|
|
@ -37,7 +37,7 @@ collections:
|
|||
### Step 2: Add your content
|
||||
|
||||
Create a corresponding folder (e.g. `<source>/_my_collection`) and add documents.
|
||||
YAML front-matter is read in as data if it exists, if not, then everything is just stuck in the Document's `content` attribute.
|
||||
YAML Front Matter is read in as data if it exists, if not, then everything is just stuck in the Document's `content` attribute.
|
||||
|
||||
Note: the folder must be named identical to the collection you defined in you config.yml file, with the addition of the preceding `_` character.
|
||||
|
||||
|
|
@ -178,7 +178,7 @@ The collections are also available under `site.collections`, with the metadata y
|
|||
|
||||
### Documents
|
||||
|
||||
In addition to any YAML front-matter provided in the document's corresponding file, each document has the following attributes:
|
||||
In addition to any YAML Front Matter provided in the document's corresponding file, each document has the following attributes:
|
||||
|
||||
<div class="mobile-side-scroller">
|
||||
<table>
|
||||
|
|
@ -195,10 +195,10 @@ In addition to any YAML front-matter provided in the document's corresponding fi
|
|||
</td>
|
||||
<td>
|
||||
<p>
|
||||
The (unrendered) content of the document. If no YAML front-matter is provided,
|
||||
this is the entirety of the file contents. If YAML front-matter
|
||||
The (unrendered) content of the document. If no YAML Front Matter is provided,
|
||||
this is the entirety of the file contents. If YAML Front Matter
|
||||
is used, then this is all the contents of the file after the terminating
|
||||
`---` of the front-matter.
|
||||
`---` of the front matter.
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
|
|||
|
|
@ -125,12 +125,12 @@ class="flag">flags</code> (specified on the command-line) that control them.
|
|||
<td>
|
||||
<p class='name'><strong>Defaults</strong></p>
|
||||
<p class='description'>
|
||||
Set defaults for <a href="../frontmatter/" title="YAML frontmatter">YAML frontmatter</a>
|
||||
Set defaults for <a href="../frontmatter/" title="YAML Front Matter">YAML Front Matter</a>
|
||||
variables.
|
||||
</p>
|
||||
</td>
|
||||
<td class='align-center'>
|
||||
<p>see <a href="#frontmatter-defaults" title="details">below</a></p>
|
||||
<p>see <a href="#front-matter-defaults" title="details">below</a></p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
|
@ -276,9 +276,9 @@ before your site is served.
|
|||
</p>
|
||||
</div>
|
||||
|
||||
## Frontmatter defaults
|
||||
## Front Matter defaults
|
||||
|
||||
Using [YAML front-matter](../frontmatter/) is one way that you can specify configuration in the pages and posts for your site. Setting things like a default layout, or customizing the title, or specifying a more precise date/time for the post can all be added to your page or post front-matter.
|
||||
Using [YAML Front Matter](../frontmatter/) is one way that you can specify configuration in the pages and posts for your site. Setting things like a default layout, or customizing the title, or specifying a more precise date/time for the post can all be added to your page or post front matter.
|
||||
|
||||
Often times, you will find that you are repeating a lot of configuration options. Setting the same layout in each file, adding the same category - or categories - to a post, etc. You can even add custom variables like author names, which might be the same for the majority of posts on your blog.
|
||||
|
||||
|
|
@ -354,9 +354,9 @@ In this example the `layout` is set to `default` inside the [collection](../coll
|
|||
|
||||
Jekyll will apply all of the configuration settings you specify in the `defaults` section of your `_config.yml` file. However, you can choose to override settings from other scope/values pair by specifying a more specific path for the scope.
|
||||
|
||||
You can see that in the last example above. First, we set the default layout to `my-site`. Then, using a more specific path, we set the default layout for files in the `projects/` path to `project`. This can be done with any value that you would set in the page or post front-matter.
|
||||
You can see that in the last example above. First, we set the default layout to `my-site`. Then, using a more specific path, we set the default layout for files in the `projects/` path to `project`. This can be done with any value that you would set in the page or post front matter.
|
||||
|
||||
Finally, if you set defaults in the site configuration by adding a `defaults` section to your `_config.yml` file, you can override those settings in a post or page file. All you need to do is specify the settings in the post or page front-matter. For example:
|
||||
Finally, if you set defaults in the site configuration by adding a `defaults` section to your `_config.yml` file, you can override those settings in a post or page file. All you need to do is specify the settings in the post or page front matter. For example:
|
||||
|
||||
{% highlight yaml %}
|
||||
# In _config.yml
|
||||
|
|
|
|||
|
|
@ -1,12 +1,12 @@
|
|||
---
|
||||
layout: docs
|
||||
title: Front-matter
|
||||
title: Front Matter
|
||||
prev_section: configuration
|
||||
next_section: posts
|
||||
permalink: /docs/frontmatter/
|
||||
---
|
||||
|
||||
The front-matter is where Jekyll starts to get really cool. Any file that
|
||||
The front matter is where Jekyll starts to get really cool. Any file that
|
||||
contains a [YAML](http://yaml.org/) front matter block will be processed by
|
||||
Jekyll as a special file. The front matter must be the first thing in the file
|
||||
and must take the form of valid YAML set between triple-dashed lines. Here is a
|
||||
|
|
@ -39,7 +39,7 @@ relies on.
|
|||
<h5>ProTip™: Front Matter Variables Are Optional</h5>
|
||||
<p>
|
||||
If you want to use <a href="../variables/">Liquid tags and variables</a> but
|
||||
don’t need anything in your front-matter, just leave it empty! The set of
|
||||
don’t need anything in your front matter, just leave it empty! The set of
|
||||
triple-dashed lines with nothing in between will still get Jekyll to process
|
||||
your file. (This is useful for things like CSS and RSS feeds!)
|
||||
</p>
|
||||
|
|
@ -48,7 +48,7 @@ relies on.
|
|||
## Predefined Global Variables
|
||||
|
||||
There are a number of predefined global variables that you can set in the
|
||||
front-matter of a page or post.
|
||||
front matter of a page or post.
|
||||
|
||||
<div class="mobile-side-scroller">
|
||||
<table>
|
||||
|
|
@ -154,7 +154,7 @@ title:
|
|||
|
||||
## Predefined Variables for Posts
|
||||
|
||||
These are available out-of-the-box to be used in the front-matter for a post.
|
||||
These are available out-of-the-box to be used in the front matter for a post.
|
||||
|
||||
<div class="mobile-side-scroller">
|
||||
<table>
|
||||
|
|
@ -183,8 +183,8 @@ These are available out-of-the-box to be used in the front-matter for a post.
|
|||
<div class="note">
|
||||
<h5>ProTip™: Don't repeat yourself</h5>
|
||||
<p>
|
||||
If you don't want to repeat your frequently used front-matter variables over and over,
|
||||
just define <a href="../configuration/#frontmatter-defaults" title="frontmatter defaults">defaults</a>
|
||||
If you don't want to repeat your frequently used front matter variables over and over,
|
||||
just define <a href="../configuration/#front-matter-defaults" title="Front Matter defaults">defaults</a>
|
||||
for them and only override them where necessary (or not at all). This works both for predefined
|
||||
and custom variables.
|
||||
</p>
|
||||
|
|
|
|||
|
|
@ -87,7 +87,7 @@ prev_section: contributing
|
|||
- Upgrade listen to `2.7.6 <= x < 3.0.0` ([#2492]({{ site.repository }}/issues/2492))
|
||||
- Allow configuration of different Twitter and GitHub usernames in site template ([#2485]({{ site.repository }}/issues/2485))
|
||||
- Bump Pygments to v0.6.0 ([#2504]({{ site.repository }}/issues/2504))
|
||||
- Front-matter defaults for documents in collections ([#2419]({{ site.repository }}/issues/2419))
|
||||
- Front matter defaults for documents in collections ([#2419]({{ site.repository }}/issues/2419))
|
||||
- Include files with a url which ends in `/` in the `site.html_pages` list ([#2524]({{ site.repository }}/issues/2524))
|
||||
- Make `highlight` tag use `language-` prefix in CSS class ([#2511]({{ site.repository }}/issues/2511))
|
||||
- Lookup item property via `item#to_liquid` before `#data` or `#[]` in filters ([#2493]({{ site.repository }}/issues/2493))
|
||||
|
|
@ -106,7 +106,7 @@ prev_section: contributing
|
|||
- Prevent code from overflowing container in site template ([#2429]({{ site.repository }}/issues/2429))
|
||||
- Encode URLs in UTF-8 when escaping and unescaping ([#2420]({{ site.repository }}/issues/2420))
|
||||
- No Layouts or Liquid for Asset Files ([#2431]({{ site.repository }}/issues/2431))
|
||||
- Allow front-matter defaults to set post categories ([#2373]({{ site.repository }}/issues/2373))
|
||||
- Allow front matter defaults to set post categories ([#2373]({{ site.repository }}/issues/2373))
|
||||
- Fix command in subcommand deprecation warning ([#2457]({{ site.repository }}/issues/2457))
|
||||
- Keep all parent directories of files/dirs in `keep_files` ([#2458]({{ site.repository }}/issues/2458))
|
||||
- When using RedCarpet and Rouge without Rouge installed, fixed erroneous
|
||||
|
|
@ -141,7 +141,7 @@ prev_section: contributing
|
|||
- Prevent table from extending parent width in permalink style table ([#2424]({{ site.repository }}/issues/2424))
|
||||
- Add collections to info about pagination support ([#2389]({{ site.repository }}/issues/2389))
|
||||
- Add `jekyll_github_sample` plugin to list of third-party plugins ([#2463]({{ site.repository }}/issues/2463))
|
||||
- Clarify documentation around front-matter defaults and add details
|
||||
- Clarify documentation around front matter defaults and add details
|
||||
about defaults for collections. ([#2439]({{ site.repository }}/issues/2439))
|
||||
- Add Jekyll Project Version Tag to list of third-party plugins ([#2468]({{ site.repository }}/issues/2468))
|
||||
- Use `https` for GitHub links across whole site ([#2470]({{ site.repository }}/issues/2470))
|
||||
|
|
@ -180,7 +180,7 @@ prev_section: contributing
|
|||
- Update docs to reflect new `baseurl` default ([#2341]({{ site.repository }}/issues/2341))
|
||||
- Add links to headers who have an ID. ([#2342]({{ site.repository }}/issues/2342))
|
||||
- Use symbol instead of HTML number in `upgrading.md` ([#2351]({{ site.repository }}/issues/2351))
|
||||
- Fix link to frontmatter defaults docs ([#2353]({{ site.repository }}/issues/2353))
|
||||
- Fix link to front matter defaults docs ([#2353]({{ site.repository }}/issues/2353))
|
||||
- Fix for `History.markdown` in order to fix history page in docs ([#2363]({{ site.repository }}/issues/2363))
|
||||
|
||||
|
||||
|
|
@ -230,7 +230,7 @@ prev_section: contributing
|
|||
- Expose `site.static_files` to Liquid ([#2075]({{ site.repository }}/issues/2075))
|
||||
- Complete redesign of the template site generated by `jekyll new` ([#2050]({{ site.repository }}/issues/2050))
|
||||
- Update Listen from 1.x to 2.x ([#2097]({{ site.repository }}/issues/2097))
|
||||
- Front-matter defaults ([#2205]({{ site.repository }}/issues/2205))
|
||||
- Front matter defaults ([#2205]({{ site.repository }}/issues/2205))
|
||||
- Deprecate `relative_permalinks` configuration option (default to `false`) ([#2307]({{ site.repository }}/issues/2307))
|
||||
- Exclude files based on prefix as well as `fnmatch?` ([#2303]({{ site.repository }}/issues/2303))
|
||||
|
||||
|
|
@ -276,7 +276,7 @@ prev_section: contributing
|
|||
- Permit YAML blocks to end with three dots to better conform with the
|
||||
YAML spec ([#2110]({{ site.repository }}/issues/2110))
|
||||
- Use `File.exist?` instead of deprecated `File.exists?` ([#2214]({{ site.repository }}/issues/2214))
|
||||
- Require newline after start of YAML front-matter header ([#2211]({{ site.repository }}/issues/2211))
|
||||
- Require newline after start of YAML Front Matter header ([#2211]({{ site.repository }}/issues/2211))
|
||||
- Add the ability for pages to be marked as `published: false` ([#1492]({{ site.repository }}/issues/1492))
|
||||
- Add `Jekyll::LiquidExtensions` with `.lookup_variable` method for easy
|
||||
looking up of variable values in a Liquid context. ([#2253]({{ site.repository }}/issues/2253))
|
||||
|
|
@ -1039,7 +1039,7 @@ prev_section: contributing
|
|||
- Bullet-proof `limit_posts` option ([#1004]({{ site.repository }}/issues/1004))
|
||||
- Read in YAML as UTF-8 to accept non-ASCII chars ([#836]({{ site.repository }}/issues/836))
|
||||
- Fix the CLI option `--plugins` to actually accept dirs and files ([#993]({{ site.repository }}/issues/993))
|
||||
- Allow 'excerpt' in YAML Front-Matter to override the extracted excerpt ([#946]({{ site.repository }}/issues/946))
|
||||
- Allow 'excerpt' in YAML Front Matter to override the extracted excerpt ([#946]({{ site.repository }}/issues/946))
|
||||
- Fix cascade problem with site.baseurl, site.port and site.host. ([#935]({{ site.repository }}/issues/935))
|
||||
- Filter out directories with valid post names ([#875]({{ site.repository }}/issues/875))
|
||||
- Fix symlinked static files not being correctly built in unsafe mode ([#909]({{ site.repository }}/issues/909))
|
||||
|
|
@ -1051,7 +1051,7 @@ prev_section: contributing
|
|||
- Patch for multibyte URI problem with `jekyll serve` ([#723]({{ site.repository }}/issues/723))
|
||||
- Order plugin execution by priority ([#864]({{ site.repository }}/issues/864))
|
||||
- Fixed Page#dir and Page#url for edge cases ([#536]({{ site.repository }}/issues/536))
|
||||
- Fix broken `post_url` with posts with a time in their YAML Front-Matter ([#831]({{ site.repository }}/issues/831))
|
||||
- Fix broken `post_url` with posts with a time in their YAML Front Matter ([#831]({{ site.repository }}/issues/831))
|
||||
- Look for plugins under the source directory ([#654]({{ site.repository }}/issues/654))
|
||||
- Tumblr Migrator: finds `_posts` dir correctly, fixes truncation of long
|
||||
post names ([#775]({{ site.repository }}/issues/775))
|
||||
|
|
@ -1118,7 +1118,7 @@ prev_section: contributing
|
|||
- Fix error with `limit_posts` ([#442]({{ site.repository }}/issues/442))
|
||||
- Properly select dotfile during directory scan ([#363]({{ site.repository }}/issues/363), [#431]({{ site.repository }}/issues/431), [#377]({{ site.repository }}/issues/377))
|
||||
- Allow setting of Kramdown `smart_quotes` ([#482]({{ site.repository }}/issues/482))
|
||||
- Ensure front-matter is at start of file ([#562]({{ site.repository }}/issues/562))
|
||||
- Ensure front matter is at start of file ([#562]({{ site.repository }}/issues/562))
|
||||
|
||||
|
||||
## 0.11.2 / 2011-12-27
|
||||
|
|
@ -1271,7 +1271,7 @@ prev_section: contributing
|
|||
{: #v0-5-6}
|
||||
- Bug Fixes
|
||||
- Require redcloth >= 4.2.1 in tests ([#92]({{ site.repository }}/issues/92))
|
||||
- Don't break on triple dashes in yaml frontmatter ([#93]({{ site.repository }}/issues/93))
|
||||
- Don't break on triple dashes in YAML Front Matter ([#93]({{ site.repository }}/issues/93))
|
||||
|
||||
### Minor Enhancements
|
||||
{: #minor-enhancements-v0-5-6}
|
||||
|
|
@ -1315,7 +1315,7 @@ prev_section: contributing
|
|||
again.
|
||||
- Configuration options set in config.yml are now available through the
|
||||
site payload ([@vilcans](https://github.com/vilcans))
|
||||
- Posts can now have an empty YAML front matter or none at all
|
||||
- Posts can now have an empty YAML Front Matter or none at all
|
||||
(@ bahuvrihi)
|
||||
- Bug Fixes
|
||||
- Fixing Ruby 1.9 issue that requires `#to_s` on the err object
|
||||
|
|
@ -1329,7 +1329,7 @@ prev_section: contributing
|
|||
([@eugenebolshakov](https://github.com/eugenebolshakov))
|
||||
- Bad markdown processor in config fails sooner and with better message
|
||||
(@ gcnovus)
|
||||
- Allow CRLFs in yaml frontmatter ([@juretta](https://github.com/juretta))
|
||||
- Allow CRLFs in YAML Front Matter ([@juretta](https://github.com/juretta))
|
||||
- Added Date#xmlschema for Ruby versions < 1.9
|
||||
|
||||
|
||||
|
|
@ -1420,7 +1420,7 @@ prev_section: contributing
|
|||
- Added post categories based on directories containing `_posts` ([@mreid](https://github.com/mreid))
|
||||
- Added post topics based on directories underneath `_posts`
|
||||
- Added new date filter that shows the full month name ([@mreid](https://github.com/mreid))
|
||||
- Merge Post's YAML front matter into its to_liquid payload ([@remi](https://github.com/remi))
|
||||
- Merge Post's YAML Front Matter into its to_liquid payload ([@remi](https://github.com/remi))
|
||||
- Restrict includes to regular files underneath `_includes`
|
||||
- Bug Fixes
|
||||
- Change YAML delimiter matcher so as to not chew up 2nd level markdown
|
||||
|
|
|
|||
|
|
@ -67,7 +67,7 @@ ignored. Jekyll does not assume any particular side-effect to happen, it just
|
|||
runs the method.
|
||||
|
||||
Generators run after Jekyll has made an inventory of the existing content, and
|
||||
before the site is generated. Pages with YAML front-matters are stored as
|
||||
before the site is generated. Pages with YAML Front Matters are stored as
|
||||
instances of
|
||||
[`Jekyll::Page`]({{ site.repository }}/blob/master/lib/jekyll/page.rb)
|
||||
and are available via `site.pages`. Static files become instances of
|
||||
|
|
@ -166,7 +166,7 @@ include it by implementing your own converter. Both the Markdown and Textile
|
|||
markup languages are implemented using this method.
|
||||
|
||||
<div class="note info">
|
||||
<h5>Remember your YAML front-matter</h5>
|
||||
<h5>Remember your YAML Front Matter</h5>
|
||||
<p>
|
||||
Jekyll will only convert files that have a YAML header at the top, even for
|
||||
converters you add using a plugin.
|
||||
|
|
@ -234,7 +234,7 @@ Converters should implement at a minimum 3 methods:
|
|||
</td>
|
||||
<td><p>
|
||||
Logic to do the content conversion. Takes one argument: the raw content
|
||||
of the file (without YAML front matter). Must return a String.
|
||||
of the file (without YAML Front Matter). Must return a String.
|
||||
</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
|
@ -543,7 +543,7 @@ You can find a few useful plugins at the following locations:
|
|||
- [grunt-jekyll](https://github.com/dannygarcia/grunt-jekyll): A straightforward [Grunt](http://gruntjs.com/) plugin for Jekyll.
|
||||
- [jekyll-postfiles](https://github.com/indirect/jekyll-postfiles): Add `_postfiles` directory and {% raw %}`{{ postfile }}`{% endraw %} tag so the files a post refers to will always be right there inside your repo.
|
||||
- [A layout that compresses HTML](https://github.com/penibelst/jekyll-compress-html) by [Anatol Broder](http://penibelst.de/): Github Pages compatible, configurable way to compress HTML files on site build.
|
||||
- [Jekyll CO₂](https://github.com/wdenton/jekyll-co2): Generates HTML showing the monthly change in atmospheric CO₂ at the Mauna Loa observatory in Hawaii.
|
||||
- [Jekyll CO₂](https://github.com/wdenton/jekyll-co2): Generates HTML showing the monthly change in atmospheric CO₂ at the Mauna Loa observatory in Hawaii.
|
||||
|
||||
#### Editors
|
||||
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ As explained on the [directory structure](../structure/) page, the `_posts`
|
|||
folder is where your blog posts will live. These files can be either
|
||||
[Markdown](http://daringfireball.net/projects/markdown/) or
|
||||
[Textile](http://redcloth.org/textile) formatted text files, and as long as
|
||||
they have [YAML front-matter](../frontmatter/), they will be converted from their
|
||||
they have [YAML Front Matter](../frontmatter/), they will be converted from their
|
||||
source format into an HTML page that is part of your static site.
|
||||
|
||||
### Creating Post Files
|
||||
|
|
@ -52,7 +52,7 @@ file. For example, the following are examples of valid post filenames:
|
|||
|
||||
### Content Formats
|
||||
|
||||
All blog post files must begin with [YAML front-matter](../frontmatter/). After
|
||||
All blog post files must begin with [YAML Front Matter](../frontmatter/). After
|
||||
that, it's simply a matter of deciding which format you prefer. Jekyll supports
|
||||
two popular content markup formats:
|
||||
[Markdown](http://daringfireball.net/projects/markdown/) and
|
||||
|
|
@ -161,7 +161,7 @@ which is already done for you. These tags can be removed with the following if y
|
|||
{% endhighlight %}
|
||||
|
||||
If you don't like the automatically-generated post excerpt, it can be overridden by adding
|
||||
`excerpt` to your post's YAML front-matter. Completely disable it by setting
|
||||
`excerpt` to your post's YAML Front Matter. Completely disable it by setting
|
||||
your `excerpt_separator` to `""`.
|
||||
|
||||
Also, as with any output generated by Liquid tags, you can pass the `| strip_html` flag to remove any html tags in the output. This is particularly helpful if you wish to output a post excerpt as a `meta="description"` tag within the post `head`, or anywhere else having html tags along with the content is not desirable.
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ For the impatient, here's how to get a boilerplate Jekyll site up and running.
|
|||
{% endhighlight %}
|
||||
|
||||
That's nothing, though. The real magic happens when you start creating blog
|
||||
posts, using the front-matter to control templates and layouts, and taking
|
||||
posts, using the front matter to control templates and layouts, and taking
|
||||
advantage of all the awesome configuration options Jekyll makes available.
|
||||
|
||||
If you're running into problems, ensure you have all the [requirements
|
||||
|
|
|
|||
|
|
@ -98,7 +98,7 @@ An overview of what each of these does:
|
|||
<p>
|
||||
|
||||
These are the templates that wrap posts. Layouts are chosen on a post-
|
||||
by-post basis in the <a href="../frontmatter/">YAML front matter</a>,
|
||||
by-post basis in the <a href="../frontmatter/">YAML Front Matter</a>,
|
||||
which is described in the next section. The liquid tag
|
||||
<code>{% raw %}{{ content }}{% endraw %}</code>
|
||||
is used to inject content into the web page.
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ permalink: /docs/variables/
|
|||
---
|
||||
|
||||
Jekyll traverses your site looking for files to process. Any files with [YAML
|
||||
Front Matter](../frontmatter/) are subject to processing. For each of these
|
||||
front matter](../frontmatter/) are subject to processing. For each of these
|
||||
files, Jekyll makes a variety of data available via the [Liquid templating
|
||||
system](http://wiki.shopify.com/Liquid). The
|
||||
following is a reference of the available data.
|
||||
|
|
@ -36,8 +36,8 @@ following is a reference of the available data.
|
|||
<td><p><code>page</code></p></td>
|
||||
<td><p>
|
||||
|
||||
Page specific information + the <a href="../frontmatter/">YAML Front
|
||||
Matter</a>. Custom variables set via the YAML front matter will be
|
||||
Page specific information + the <a href="../frontmatter/">YAML front
|
||||
matter</a>. Custom variables set via the YAML Front Matter will be
|
||||
available here. See below for details.
|
||||
|
||||
</p></td>
|
||||
|
|
@ -310,7 +310,7 @@ following is a reference of the available data.
|
|||
</div>
|
||||
|
||||
<div class="note">
|
||||
<h5>ProTip™: Use custom front-matter</h5>
|
||||
<h5>ProTip™: Use Custom Front Matter</h5>
|
||||
<p>
|
||||
|
||||
Any custom front matter that you specify will be available under
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ Jam-packed with some [highly-requested features and bugfixes galore][changelog],
|
|||
1. [Collections](/docs/collections/) - Collections allow you to define an unlimited number of custom document types (beyond just posts and pages) for different types of content you may want to author in Jekyll such as API documentation or a cookbook!
|
||||
2. [Brand new site template](https://github.com/jekyll/jekyll/pull/2050#issuecomment-35938016) (thanks [@jglovier][]!) - Getting started with Jekyll just got a lot easier and a lot more beautiful. Just run `jekyll new <path>` and you're good to go.
|
||||
3. [Native Sass & CoffeeScript support](/docs/assets/) - We love CSS and JavaScript as much as the next guy, but there will always be a special place in our hearts for Sass and CoffeeScript. We now offer native support for these file types — no more messing around with Rake or Grunt!
|
||||
4. [YAML Front-Matter defaults](/docs/configuration/#frontmatter-defaults) - If you've set `layout: post` more than once in your life, you'll love this new feature: set front-matter defaults for a given directory or type.
|
||||
4. [YAML Front Matter defaults](/docs/configuration/#front-matter-defaults) - If you've set `layout: post` more than once in your life, you'll love this new feature: set front matter defaults for a given directory or type.
|
||||
5. [Custom markdown processors](/docs/configuration/#custom-markdown-processors) - Always wanted to use your favourite home-grown Markdown converter, but couldn't with Jekyll? Now you can. Simply specify `markdown: MyConverterClass` and you're on your way.
|
||||
6. [Addition of `where` and `group_by` Liquid filters](/docs/templates/#filters) - Simplifying your Liquid templates one filter at a time. The `where` filter selects from an array all items within which have a given value for a property. The `group_by` filter groups all items in an array which have the same value for a given property.
|
||||
7. [Switch from Maruku to Kramdown as default markdown converter](https://github.com/jekyll/jekyll/pull/1988) - Maruku is dead. We've replaced it with the converter which has the closest feature parity: Kramdown!
|
||||
|
|
|
|||
|
|
@ -12,13 +12,13 @@ And he's done a lot of learning in the process! Here are some of the new
|
|||
things to look forward to:
|
||||
|
||||
- Uses the latest Liquid version (2.6.1) (#2495)
|
||||
- Set front-matter defaults for collections (#2419)
|
||||
- Set front matter defaults for collections (#2419)
|
||||
- Set a collection-specific URL template (#2418)
|
||||
- `pygments.rb` 0.6.0! (#2504)
|
||||
- `.json` files in `_data` (#2369)
|
||||
- Allow subdirectories in `_data` (#2395)
|
||||
- Add support for `hl_lines` in `highlight` tag (#2532)
|
||||
- Post categories now merge with directory, front-matter, and defaults (#2373)
|
||||
- Post categories now merge with directory, front matter, and defaults (#2373)
|
||||
- New `--skip_initial_build` flag for `jekyll serve` (#2477)
|
||||
- A bajilion bug fixes and site updates!
|
||||
|
||||
|
|
|
|||
|
|
@ -69,7 +69,7 @@ class TestDocument < Test::Unit::TestCase
|
|||
assert_equal({
|
||||
"title"=>"Example slide",
|
||||
"layout"=>"slide",
|
||||
"nested"=> {
|
||||
"nested"=> {
|
||||
"key"=>"myval"
|
||||
}
|
||||
}, @document.data)
|
||||
|
|
@ -100,7 +100,7 @@ class TestDocument < Test::Unit::TestCase
|
|||
assert_equal({
|
||||
"title"=>"Override title",
|
||||
"layout"=>"slide",
|
||||
"nested"=> {
|
||||
"nested"=> {
|
||||
"test1"=>"override1",
|
||||
"test2"=>"override2"
|
||||
}
|
||||
|
|
@ -131,7 +131,7 @@ class TestDocument < Test::Unit::TestCase
|
|||
assert_equal({
|
||||
"title"=>"Example slide",
|
||||
"layout"=>"slide",
|
||||
"nested"=> {
|
||||
"nested"=> {
|
||||
"key"=>"value123"
|
||||
}
|
||||
}, @document.data)
|
||||
|
|
|
|||
Loading…
Reference in New Issue