To setup your site's blog, start by creating a
Then, add a navbar link to your blog within
To publish in the blog, create a file within the blog directory 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
The only required field is
title; however, we provide options to add author information to your blog post as well along with other options.
author- The author name to be displayed.
author_url- The URL that the author's name will be linked to. This could be a GitHub, Twitter, Facebook profile URL, etc.
author_image_url- The URL to the author's thumbnail image.
author_title- A description of the author.
title- The blog post title.
tags- A list of strings to tag to your post.
draft- A boolean flag to indicate that the blog post is work in process and therefore should not be published yet. However, draft blog posts will be displayed during development.
<!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. Anything above
<!--truncate--> will be part of the summary. For example:
You can generate RSS/ Atom feed by passing feedOptions.
Accessing the feed:
The feed for RSS can be found at:
and for Atom:
You can run your Docusaurus 2 site without a landing page and instead have your blog's post list page as the index page. Set the
routeBasePath to be
'/' to indicate it's the root path.
Make sure there's no
index.js page in
src/pages or else there will be two files mapping to the same route!