adds more information to the documentation of generators #1590

Merged
merged 1 commit into from Sep 30, 2013

Projects

None yet

2 participants

@fxn
Contributor
fxn commented Sep 30, 2013

I had to write a generator for the first time and missed some information in the existing docs. I saved some internal cosmic energy by not complaining on Twitter and redirected it to sit my ass on a chair and write this PR :).

  • Defines what is a generator.
  • Documents the (non-existing) contract of generate.
  • Explains when do generators run.
  • Covers site.pages and site.static_files.
  • Adds a more simple example where we inject data into an existing page.
  • Revises the description of generate in the table at the bottom.
@mattr-
Member
mattr- commented Sep 30, 2013

Awesome!

Thank you!

@mattr- mattr- merged commit 670ec70 into jekyll:master Sep 30, 2013

1 check failed

default The Travis CI build failed
Details
@mattr- mattr- added a commit that referenced this pull request Sep 30, 2013
@mattr- mattr- Update history to reflect merge of #1590 92907c9
@mattr- mattr- added a commit that referenced this pull request Oct 3, 2013
@mattr- mattr- Update history to reflect merge of #1592
Combine it with the entry for #1590 since they're related. Move it
down to the site enhancements section since both pulls are changes to
the site.
7d56426
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment