Clarify documentation in theme gem's README template #5376

Merged
merged 2 commits into from Sep 21, 2016

Projects

None yet

6 participants

@jonblatho
Contributor

This clarification is subtle, but may prove greatly useful to Jekyll newbies who can't piece together the line of YAML with the instructions above.

I weighed between the solution I proposed and this alternative line of instruction:

And add this line to your Jekyll site's configuration file:

Either works sufficiently.

@jonblatho jonblatho Clarify documentation in README
This change is subtle, but may prove greatly useful to Jekyll newbies
1a11536
@ashmaroli
Contributor
ashmaroli commented Sep 19, 2016 edited

This is not related to the repo's README hence please update the title to:
Clarify documentation in theme gem's README template.

/cc @jekyll/documentation

@DirtyF DirtyF was assigned by jekyllbot Sep 19, 2016
@DirtyF
DirtyF approved these changes Sep 19, 2016 View changes

LGTM

lib/theme_template/README.md.erb
@@ -12,7 +12,7 @@ Add this line to your Jekyll site's Gemfile:
gem <%= theme_name.inspect %>
```
-And add this line to your Jekyll site:
+And add this line to your Jekyll site's _config.yml:
@DirtyF
DirtyF Sep 19, 2016 Member

Please mark _config.yml with backticks here.

@DirtyF

Just a minor modification

@jonblatho jonblatho changed the title from Clarify documentation in README to Clarify documentation in theme gem's README template Sep 19, 2016
@jonblatho jonblatho Marking filename with backticks as suggested
f2bfc83
@jonblatho
Contributor

Made both suggested changes.

@pathawks

Failing Rubocop tests are totally unrelated.

@DirtyF
DirtyF approved these changes Sep 19, 2016 View changes

LGTM

@parkr
Member
parkr commented Sep 21, 2016

@jekyllbot: merge +bug

@jekyllbot jekyllbot merged commit ee84a95 into jekyll:master Sep 21, 2016

0 of 2 checks passed

continuous-integration/appveyor/pr AppVeyor build failed
Details
continuous-integration/travis-ci/pr The Travis CI build failed
Details
@jekyllbot jekyllbot added bug fix labels Sep 21, 2016
@parkr parkr added the themes label Sep 21, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment