Create a New Blog Post
Create a new blog post in the /blog/ directory following the project's established conventions.
Directory Structure
Create a folder-based blog post:
code
blog/YYYY-MM-DD-slug-name/ ├── index.mdx └── (optional images)
Use today's date: $ARGUMENTS[0] as the post title.
Frontmatter Template
mdx
--- title: <Title from arguments> authors: [kaizen] slug: <category/kebab-case-title> tags: [<relevant tags from $ARGUMENTS[1] or inferred>] ---
Content Guidelines
- •Start with a
## Introductionsection explaining the topic - •Use clear headings (
##,###) to organize content - •Include code blocks with language identifiers (
python,bash, etc.) - •Use Mermaid diagrams (
```mermaid) for architecture/flow visualizations when appropriate - •Use KaTeX math expressions when needed:
$inline$or$$block$$ - •Add
{/* truncate */}after the introduction paragraph to control the blog list preview - •Use MDX features (JSX components, imports) when it enhances the content
- •End with a summary or conclusion section
Available MDX Features
- •Mermaid diagrams (theme
@docusaurus/theme-mermaidis configured) - •Live code blocks (
@docusaurus/theme-live-codeblock) - •KaTeX math (via
remark-mathandrehype-katex) - •Image zoom (via
docusaurus-plugin-image-zoom) - •Admonitions:
:::tip,:::note,:::warning,:::danger,:::info
Author
Always use authors: [kaizen] - this maps to the blog author defined in blog/authors.yml.
After creating the blog post, confirm the file was created and suggest running npm start to preview.