-
-
Notifications
You must be signed in to change notification settings - Fork 9.9k
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
Addition of a sample "typical post" #5473
Conversation
/cc @jekyll/documentation |
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.
AFAIAC I stay neutral to add a post example in the documentation, even if Jekyll already comes with a default post.
date: 2015-11-17 16:16:01 -0600 | ||
categories: jekyll update | ||
--- | ||
You’ll find this post in your `_posts` directory. Go ahead and edit it and re-build the site to see your changes. You can rebuild the site in many different ways, but the most common way is to run `jekyll serve`, which launches a web server and auto-regenerates your site when a file is updated. |
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.
please change command to bundle exec jekyll serve
to be coherent with the rest of the documentation.
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.
Updated, but this is pulled directly from the sample post in the current _posts directory in the repo.
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.
There are some minor capitalization errors (e.g. 'Title' should be 'title') but in general I think this is a good thing. Folks reading the documentation about posts might find an example very helpful.
Hi @kentonh, could you 🙏 rebase this before merge? Docs have moved to |
So, I thought this section in the docs would be a good place to put the anatomy of a post .md file.
Updated to be consistent with the rest of documentation.
@jekyllbot: merge +docs closes #5735 |
Ugh what was up with those 250 commits? 😕 |
@zdroid refresh 😅 |
@DirtyF Yeah, I noticed. Imagine merging 250 commits. 😆 |
So, I thought this section in the docs would be a good place to put the anatomy of a post .md file.