Skip to content
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

Improve the wording in index.md #175

Merged
merged 5 commits into from Mar 10, 2018
Merged

Improve the wording in index.md #175

merged 5 commits into from Mar 10, 2018

Conversation

adamatan
Copy link
Contributor

@adamatan adamatan commented Jan 3, 2018

The current comment in index.md was confusing to me as a new Jekyll developer; it seemed to suggest that the content should be added directly to _layouts/home.html instead of index.md. This fix strives to clarify the roles of each file.

The current comment in index.md was confusing to me as a new Jekyll developer; it seemed to suggest that the content should be added directly to _layouts/home.html instead of index.md. This fix strives to clarify the roles of each file.
@adamatan adamatan changed the title Improve thw wording in index.md Improve the wording in index.md Jan 3, 2018
DirtyF
DirtyF approved these changes Jan 3, 2018
@ashmaroli
Copy link
Member

@ashmaroli ashmaroli commented Jan 3, 2018

The index.md here is only used for the demo Minima, on GitHub Pages. For the clarification to benefit new developers on Jekyll, please submit a patch the template at jekyll/jekyll as well..

@adamatan
Copy link
Contributor Author

@adamatan adamatan commented Jan 3, 2018

@ashmaroli What should be the right reference to the HTML file? "Change the _layouts/home.html file in your theme directory?

@ashmaroli
Copy link
Member

@ashmaroli ashmaroli commented Jan 4, 2018

What should be the right reference to the HTML file?

The best thing would be to make changes to Jekyll's official documentation.

The index.md you're editing here will only be available for those whose are cloning this repo. In that situation, a simple Edit _layouts/home.html to make changes to the layout for this page would be sufficient.
But for users starting fresh by running jekyll new, they'll have to follow the instructions in the section at the URL mentioned in the comment, to customize the layout.. i.e. copy _layouts/home.html from the Minima gem (or this repo) into their site source directory and then edit that copy.

@DirtyF DirtyF merged commit fbacae9 into jekyll:master Mar 10, 2018
2 checks passed
@jekyllbot jekyllbot mentioned this pull request Mar 10, 2018
@jekyll jekyll locked and limited conversation to collaborators Apr 30, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants