2.4 KiB
| id | title |
|---|---|
| blog | Adding a Blog |
Initial Setup
To setup your site's blog, start by creating a blog folder within your repo's website directory.
Then, add a header link to your blog within siteConfig.js:
headerLinks: [
...
{blog: true, label: 'Blog'},
...
]
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, at website/blog/2017-08-18-Introducing-Docusaurus.md:
---
author: Frank Li
authorURL: https://twitter.com/foobarbaz
authorFBID: 503283835
title: Introducing Docusaurus
---
Lorem Ipusm..
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 <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all blog published blog posts. Anything above <!--truncate--> will be part of the summary. For example:
---
title: Truncation Example
---
All this will be part of the blog post summary.
Even this.
<!--truncate-->
But anything from here on down will not be.
Not this.
Or this.
Changing How Many Blog Posts Show on Sidebar
By default, 5 recent blog posts are shown on the sidebar.
You can configure a specific amount of blog posts to show by adding a blogSidebarCount setting to your siteConfig.js.
The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.
Example:
blogSidebarCount: 'ALL'
RSS Feed
Docusaurus provides a simple RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically to your website page's HTML <HEAD> tag.
A summary of the post's text is provided in the RSS feed up to the <!--truncate-->. If no <!--truncate--> tag is found, then all text up 250 characters are used.
Social Buttons
If you want Facebook and/or Twitter social buttons at the bottom of your blog posts, set the facebookAppId and/or twitter site configuration options in siteConfig.js.