diff --git a/docs/guides-blog.md b/docs/guides-blog.md index ed19f8c642..ea73b0264f 100644 --- a/docs/guides-blog.md +++ b/docs/guides-blog.md @@ -17,11 +17,12 @@ headerLinks: [ ] ``` -## Adding blog posts + +## Adding Posts To publish in the blog, create a file within the blog folder with a formatted name of `YYYY-MM-DD-My-Blog-Post-Title.md`. The post date is extracted from the file name. -For example, we will create the following file `website/blog/2017-08-18-Introducing-Docusaurus.md`: +For example, at `website/blog/2017-08-18-Introducing-Docusaurus.md`: ``` --- @@ -34,7 +35,18 @@ title: Introducing Docusaurus Lorem Ipusm.. ``` -## Blog Post Summaries + +## Header Options + +The only required field is `title`; however, we provide options to add author information to your blog post as well. + +- `author` - The text label of the author byline. +- `authorURL` - The url associated with the author. This could be a Twitter, GitHub, Facebook account, etc. +- `authorFBID` - The Facebook ID that is used to extract the profile picture. +- `title` - The blog post title. + + +## Summary Truncation Use the `` marker in your blog post to represent what will be shown as the summary when viewing all blog published blog posts. Anything above `` will be part of the summary. For example: @@ -55,11 +67,3 @@ Not this. Or this. ``` -## Special blog post header options - -The only required field is `title`; however, we provide options to add author information to your blog post as well. - -- `author` - The text label of the author byline. -- `authorURL` - The url associated with the author. This could be a Twitter, GitHub, Facebook account, etc. -- `authorFBID` - The Facebook ID that is used to extract the profile picture. -- `title` - The blog post title.