mdgarden Documentation

mdgarden 🌱

mdgarden turns a folder of Markdown notes into a fast, themeable static website — search, backlinks, tags, an interactive graph view, dark mode, math, and syntax highlighting, with no runtime framework and no native dependencies. It speaks Obsidian-flavored Markdown, so an existing Obsidian vault (or any pile of .md files) works out of the box.

This vault is the documentation — and it's also what we build against during development (npm run vault:dev), so every page on the left doubles as a real, rendered example of the feature it describes.

Start here

• Download — every install method, side by side
• Installation — npm, Homebrew, or a standalone binary
• Initial Setup — the mdgarden init wizard, prompt by prompt
• Quick Start — build your first site in under a minute
• Configuration — mdgarden.config.json, themes, and feature flags
• Updating — keep an existing install current

Guide

• Markdown Syntax — wikilinks, embeds, callouts, footnotes, frontmatter
• CLI Reference — every command and flag
• Themes & Customization — presets, custom colors, custom CSS
• Architecture — how the codebase is organized

Showcase

• Diagrams — Mermaid flowcharts, sequence diagrams, and a hand-drawn SVG
• Code Highlighting — Shiki syntax highlighting across languages
• Math — KaTeX inline and block equations

Support

• Troubleshooting — common problems and fixes
• Reporting Issues — how to file a useful bug report
• Contributing — local dev setup, tests, and PRs

About

• About — what mdgarden is, and who builds it
• Donate — ways to support development

Why mdgarden?