MkDocs

MkDocs is a Python based static site generator, when combined with Material for MkDocs it allows easily creating documentation sites.

Diagrams

• Diagrams - Material for MkDocs docs

Images

• Images - Material for MkDocs docs

Admonitions

• Admonitions - Material for MkDocs docs

Code Blocks

<language> title=<title>

Common languages

• typescript
• bash
• ini
• terraform (works for HCL too)

For a full list of supported languages see: Pygments - Languages

Deploying to Vercel

Configure the project with the following sections:

• Framework: Other
• Build Command: mkdocs build
• Output Directory: site
• Install Command: pip install -r requirements.txt

---

Last update: August 5, 2023
Created: May 27, 2023