-
Notifications
You must be signed in to change notification settings - Fork 3.8k
Docs: clarification about page title #142
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
Conversation
README.md
Outdated
@@ -35,7 +35,7 @@ Refers to files within the `_layouts` directory, that define the markup for your | |||
|
|||
- `default.html` — The base layout that lays the foundation for subsequent layouts. The derived layouts inject their contents into this file at the line that says ` {{ content }} ` and are linked to this file via [FrontMatter](https://jekyllrb.com/docs/frontmatter/) declaration `layout: default`. | |||
- `home.html` — The layout for your landing-page / home-page / index-page. | |||
- `page.html` — The layout for your documents that contain FrontMatter, but are not posts. | |||
- `page.html` — The layout for your documents that contain FrontMatter, but are not posts. By default (unlike posts), page FrontMatter requires a `title` attribute, in order for a link to the page to be generated (in `header.html`). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IMO, instead of adding it here, it'd be better next to _includes - header.html
with the following edit:
- By default (unlike posts), page FrontMatter requires a `title` attribute, in order for a link to the page to
- be generated (in `header.html`).
+ Displays a list of Pages with `title` set in the FrontMatter
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see where you're coming from, but that doesn't address part of the underlying issue, that no title in Page FrontMatter, leads to... nothing, whereas with a Post, no title DWIM. Do you think your version is explicit enough that it's clear that no Page title => no output?
Perhaps.. perhaps not. The trouble with
is that it doesn't convey the essence in a simple manner. I'll break it out to illustrate.
posts or any other collection items have no say here..in the
|
@ashmaroli Thanks for the feedback, commit amended to suit, let me know what you think. |
LGTM now. /cc @DirtyF |
Thank you @antgel for the edit! 😄 🔗 💥 |
Merge pull request 121
Merge pull request 88
@jekyllbot: merge +docs Thanks @antgel! |
I had to dig into the source code to find out why my page links weren't automagically generated - this patch will help others in the same boat.