Skip to main content

Welcome

· One min read
Sean Hwang
A Mobile Developer
Sébastien Lorber
Docusaurus maintainer
Yangshun Tay
Front End Engineer @ Facebook

Docusaurus blogging features are powered by the blog plugin.

Simply add Markdown files (or folders) to the blog directory.

Let's talk how to use the blog items.

First, Use a <!-- truncate --> comment to limit blog post size in the list view.

This part only show when you click the post.

Author

Regular blog authors can be added to authors.yml.

Or, you can define in the frontmatter like:

---
slug: first-blog-post
title: First Blog Post
authors:
name: Sean Hwang
title: A Mobile Developer
url: https://github.com/SeanYHwang?tab=repositories
image_url: https://avatars.githubusercontent.com/u/86219550?v=4
tags: [hello, world]
---

Filename for a post

The blog post date can be extracted from filenames, such as:

  • 2019-05-30-welcome.md
  • 2019-05-30-welcome/index.md

Others

A blog post folder can be convenient to co-locate blog post images:

Docusaurus Plushie

The blog supports tags as well!

And if you don't want a blog: just delete this directory, and use blog: false in your Docusaurus config.