Md Of Programer

When inserting diagrams into a Markdown document, always follow the rules below.

Dependency Check

Before doing anything, check that dependencies are installed:

which mddoc && which d2

If mddoc is not installed:

npm install -g mddoc-cli

If d2 is not installed:

• macOS: brew install d2
• Windows: winget install terrastruct.d2
• Linux / others: see https://d2lang.com/tour/install

Make sure both are available before continuing.

Rules

• All diagram source files and PNGs go only in the .mddoc/ directory (alongside the Markdown file)
• File names must use lowercase English + hyphens (auth-flow, module-overview) — no spaces or numbers
• Always write the source file first, then generate the PNG, then embed into Markdown — in that order
• Never write D2 or markmap code blocks directly in the Markdown body
• Create .mddoc/ if it does not exist

Mind Map (.mmd)

1. Write the source file → .mddoc/.mmd in markmap markdown format:

# Root node

## Branch one
- Leaf node
- Leaf node

## Branch two
- Leaf node
  - Child leaf

2. Generate PNG:

mddoc mindmap .mddoc/<name>.mmd

3. Embed in Markdown:

![Mind map: <description>](.mddoc/<name>.png)
*Source: [<name>.mmd](.mddoc/<name>.mmd)*

Architecture Diagram (.d2)

1. Write the source file → .mddoc/.d2 in D2 language:

direction: right

client: Client {shape: rectangle}
gateway: API Gateway {shape: rectangle}
db: Database {shape: cylinder}

client -> gateway -> db

2. Generate PNG:

mddoc arch .mddoc/<name>.d2

3. Embed in Markdown:

![Architecture: <description>](.mddoc/<name>.png)
*Source: [<name>.d2](.mddoc/<name>.d2)*

Regenerate All Diagrams

mddoc build

Feedback

Issues and suggestions → https://github.com/drunkpig/md-of-programer/issues