New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adds more information to the documentation of generators #1590

Merged
merged 1 commit into from Sep 30, 2013

Conversation

Projects
None yet
3 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-

This comment has been minimized.

Member

mattr- commented Sep 30, 2013

Awesome!

Thank you!

mattr- added a commit that referenced this pull request Sep 30, 2013

Merge pull request #1590 from fxn/master
adds more information to the documentation of generators

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

1 check failed

default The Travis CI build failed
Details

mattr- added a commit that referenced this pull request Sep 30, 2013

mattr- added a commit that referenced this pull request Oct 3, 2013

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.

@jekyll jekyll locked and limited conversation to collaborators Feb 27, 2017

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.