Skip to main content

Adding New Blog Content

This short guide explains how to add a new blog post (and any supporting metadata) without introducing the demo content that shipped with the starter project.

1. Decide on meta information​

  1. Pick a filename in the format YYYY-MM-DD-slug.md. The date controls ordering.
  2. Draft the front matter. At minimum include title, description, authors, tags, and slug. Example:
---
slug: release-notes-july
title: July Release Notes
description: A quick recap of what shipped this month.
authors: [chanon]
tags: [announcement, roadmap]
---

2. Register authors and tags when needed​

  • Authors live in blog/authors.yml. Each key should match the value you assign inside authors. Only add the fields you need (name, title, optional links).
  • Tags live in blog/tags.yml. Every tag entry needs a label, permalink, and description so the generated tag pages make sense.

3. Write the post​

  • Place the Markdown file under blog/. Markdown and MDX are both supported, so you can import React components when helpful.
  • Add <!-- truncate --> after the intro paragraph to control the excerpt on the listing page.
  • If you need images, create a folder instead of a file (e.g. 2024-07-30-release-notes/) and store assets alongside index.md. Reference them with relative paths such as ![Diagram](./diagram.png).

4. Preview locally​

Run the dev server from the project root:

npm install   # first time only
npm run start

Visit http://localhost:3000/blog to confirm the post renders, metadata looks right, and the author page builds without errors.

5. Submit the change​

  • Commit both the post and any edits to authors.yml/tags.yml.
  • Open a pull request that includes context, screenshots, or Loom videos for reviewers.
  • Once merged, the production site will rebuild and publish the entry automatically.

Following this checklist keeps the blog free of placeholder data and ensures every story has the context readers need.