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

Clarify documentation in theme gem's README template #5376

Merged
merged 2 commits into from Sep 21, 2016

Conversation

Projects
None yet
6 participants
@jonblatho
Contributor

jonblatho commented Sep 18, 2016

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.

Clarify documentation in README
This change is subtle, but may prove greatly useful to Jekyll newbies
@ashmaroli

This comment has been minimized.

Show comment
Hide comment
@ashmaroli

ashmaroli Sep 19, 2016

Member

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

Member

ashmaroli commented Sep 19, 2016

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 approved these changes Sep 19, 2016

LGTM

Show outdated Hide outdated 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:

This comment has been minimized.

@DirtyF

DirtyF Sep 19, 2016

Member

Please mark _config.yml with backticks here.

@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

This comment has been minimized.

Show comment
Hide comment
@jonblatho

jonblatho Sep 19, 2016

Contributor

Made both suggested changes.

Contributor

jonblatho commented Sep 19, 2016

Made both suggested changes.

@pathawks

Failing Rubocop tests are totally unrelated.

@DirtyF

DirtyF approved these changes Sep 19, 2016

LGTM

@parkr

This comment has been minimized.

Show comment
Hide comment
@parkr

parkr Sep 21, 2016

Member

@jekyllbot: merge +bug

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

jekyllbot added a commit that referenced this pull request Sep 21, 2016

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