Skip to main content
Version: current

Blog

Creating a blog is relatively straightforward process in Makersaurus.

Setting up a blog​

Add a blog property to makersaurus.config.js with the following configuration:

blog: {
  blogTitle: "Your blog title", // required
  blogDescription: "Your blog description", // required
  blogSidebarTitle: "All posts", // defaults to "All posts"
  blogSidebarCount: "ALL", // defaults to "ALL"
  postsPerPage: "ALL", // defaults to "ALL"
  showReadingTime: true, // defaults to true
}

Next, add a link to your blog in sidebars.js:

{
  type: "link",
  label: "Your blog title",
  href: "/blog",
},

Now create a folder called blog and start writing! Follow the instructions in the Docusaurus documentation. All of the standard front matter metadata fields should be supported.

Development​

Changes to markdown files in the blog folder should get picked up automatically while npm start is running, but if you change the configuration you will need to restart Makersaurus for the changes to take affect.

Feedback