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

another pass on the documentation of generators #1592

Merged
merged 1 commit into from Oct 3, 2013

Conversation

Projects
None yet
4 participants
@fxn
Contributor

fxn commented Oct 1, 2013

This commit refines the docs contributed in f074bb6:

  • Fixes the links to point to this repo.
  • Uses fixed-width font for files and template variables, according to the overall style in the docs.
  • Mentions YAML "front-matters" instead of "headers", also following the terminology in the docs ("header" is used in the source code).
  • Assorted rewordings.
another pass on the documentation of generators
This commit refines the docs contributed in f074bb6.
@@ -42,22 +42,25 @@ based on your own rules.
A generator is a subclass of `Jekyll::Generator` that defines a `generate`
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).

This comment has been minimized.

@parkr

parkr Oct 1, 2013

Member

Great catch, thank you :)

This comment has been minimized.

@parkr

parkr Oct 1, 2013

Member

Might want to document how the site is accessed (via context.registers)

@parkr

This comment has been minimized.

Member

parkr commented Oct 1, 2013

LGTM! @mattr-?

@fxn

This comment has been minimized.

Contributor

fxn commented Oct 1, 2013

Hey guys! The PR was updated with site.repository. Do you want me to add anything else?

@mattr-

This comment has been minimized.

Member

mattr- commented Oct 3, 2013

Nope, this looks great. Thank you!

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

Merge pull request #1592 from fxn/master
another pass on the documentation of generators

@mattr- mattr- merged commit 3a72906 into jekyll:master Oct 3, 2013

1 check failed

default The Travis CI build failed
Details

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.