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

another pass on the documentation of generators 

This commit refines the docs contributed in f074bb6.
This commit is contained in:
Xavier Noria 2013-10-01 09:37:26 +02:00
parent f074bb6ae6
commit 4e2217986f
1 changed files with 13 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
site/docs/plugins.md
View File

@ -42,22 +42,25 @@ based on your own rules.
A generator is a subclass of `Jekyll::Generator` that defines a `generate` A generator is a subclass of `Jekyll::Generator` that defines a `generate`
method, which receives an instance of method, which receives an instance of
[`Jekyll::Site`](https://github.com/fxn/jekyll/blob/master/lib/jekyll/site.rb). [`Jekyll::Site`]({{ site.repository }}/blob/master/lib/jekyll/site.rb).
Generation is triggered for its side-effects, the return value of `generate` is Generation is triggered for its side-effects, the return value of `generate` is
ignored. Jekyll does not assume any particular side-effect to happen, it just ignored. Jekyll does not assume any particular side-effect to happen, it just
runs the method. runs the method.
Generators run after Jekyll has made an inventory of the existing pages, and Generators run after Jekyll has made an inventory of the existing content, and
before the site is generated. Pages with YAML headers are stored as instances of before the site is generated. Pages with YAML front-matters are stored as
[`Jekyll::Page`](https://github.com/fxn/jekyll/blob/master/lib/jekyll/page.rb) instances of
[`Jekyll::Page`]({{ site.repository }}/blob/master/lib/jekyll/page.rb)
and are available via `site.pages`. Static files become instances of and are available via `site.pages`. Static files become instances of
[`Jekyll::StaticFile`](https://github.com/fxn/jekyll/blob/master/lib/jekyll/static_file.rb) [`Jekyll::StaticFile`]({{ site.repository }}/blob/master/lib/jekyll/static_file.rb)
and are available via `site.static_files`. and are available via `site.static_files`. See
[`Jekyll::Site`]({{ site.repository }}/blob/master/lib/jekyll/site.rb)
for more details.
For example, if an existing Liquid template has data that needs to be computed For instance, a generator can inject values computed at build time for template
at build time, a generator can search for it and inject it. In the following variables. In the following example the template `reading.html` has two
example the template called "reading.html" has two variables "ongoing" and variables `ongoing` and `done` that we fill in the generator:
"done" that we fill in the generator.
{% highlight ruby %} {% highlight ruby %}
module Reading module Reading