AI agents: fetch the documentation index at llms.txt. Markdown versions are available by appending .md to any page URL, including this page's markdown.
How it works
See how local MDX, the blodemd CLI, Hono API, Vercel Blob storage, and the Next.js renderer work together when you push documentation.
Blode.md turns local MDX files into a hosted documentation site. Here is how the pieces fit together.
Architecture
Your repo CLI API CDN + Renderer
───────── ───────── ───────── ───────────────
docs/ ───► blodemd ───► Hono API ───► Next.js app
├ docs.json push ├ validate ├ tenant routing
├ index.mdx ├ store in ├ MDX rendering
└ *.mdx │ Vercel Blob ├ Shiki highlighting
└ build indices └ edge caching
What happens when you push
Validate
The CLI reads docs.json and validates it against the configuration schema.
If the config is invalid, the push stops with an error.
Collect files
All files in your docs directory are collected. Dotfiles and node_modules
are skipped.