another pass on the documentation of generators #1592

Merged
merged 1 commit into from Oct 3, 2013

Projects

None yet

3 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.
@fxn fxn another pass on the documentation of generators
This commit refines the docs contributed in f074bb6.
4e22179
@parkr parkr commented on the diff Oct 1, 2013
site/docs/plugins.md
@@ -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).
@parkr
parkr Oct 1, 2013 Member

Great catch, thank you :)

@parkr
parkr Oct 1, 2013 Member

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

@parkr
Member
parkr commented Oct 1, 2013

LGTM! @mattr-?

@fxn
Contributor
fxn commented Oct 1, 2013

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

@mattr-
Member
mattr- commented Oct 3, 2013

Nope, this looks great. Thank you!

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

1 check failed

default The Travis CI build failed
Details
@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