Repolode
Submit
docmd-io

docmd-io/docmd

A Markdown documentation compiler that turns one source folder into a static docs website, offline search, llms.txt, and AI-agent context.

Open-source alternative to:DocusaurusMintlify

View on GitHubWebsite
Stars
2,528
Forks
144
Open issues
2
Last commit
4 days ago

What is it?

docmd is a documentation compiler built on Node.js. You point it at a folder of Markdown files and it generates a navigable static website with navigation derived from the file structure, so no config file or frontmatter is needed to start. A single build also produces an offline search index, sitemap, SEO and Open Graph metadata, and robots.txt.

The same source can feed machine-readable outputs as well. docmd generates llms.txt and llms-full.txt, Open Knowledge Format bundles for RAG systems, and an MCP server that lets coding agents search, read and validate docs. An optional AI Assistant plugin provides RAG-based chat over the documentation, either with your own provider or through the hosted Cloud Relay.

The project supports internationalisation, versioning, monorepo workspaces, OpenAPI 3.x rendering, Mermaid diagrams and a plugin system. It includes a migration command for projects coming from Docusaurus, VitePress, MkDocs or Starlight. The output can be deployed to any static host, and the compiler and core plugins are MIT-licensed.

Key features

  • 01Generates a static docs site with navigation built from the file structure
  • 02Offline full-text search, sitemap, canonical URLs and Open Graph metadata
  • 03Outputs llms.txt, llms-full.txt and Open Knowledge Format bundles
  • 04MCP server for coding agents to search, read and validate docs
  • 05Internationalisation, versioning and monorepo workspaces
  • 06OpenAPI 3.x rendering and Mermaid diagram support

Use cases

  • Publishing project documentation from an existing Markdown folder with no setup
  • Giving LLMs and coding agents structured context from your docs
  • Migrating an existing Docusaurus, VitePress or MkDocs site
  • Hosting multilingual API documentation on any static host

Quick start

  1. 1

    Point docmd at a Markdown folder and start the dev server

    npx @docmd/core dev
  2. 2

    Build a static site for deployment

    npx @docmd/core build

Things to know

  • Requires Node.js 20 or newer.
  • Optional features such as the AI Assistant need your own AI provider key or Cloud Relay, and model usage may be charged separately.

Topics

#documentation#markdown#static-site-generator#llms-txt#mcp#openapi#i18n#typescript#ai-skills#api

FAQ

What is docmd?
A Markdown documentation compiler that turns one source folder into a static docs website, offline search, llms.txt, and AI-agent context. docmd is a documentation compiler built on Node.js. You point it at a folder of Markdown files and it generates a navigable static website with navigation derived from the file structure, so no config file or frontmatter is needed to start. A single build also produces an offline search index, sitemap, SEO and Open Graph metadata, and robots.txt.
Is docmd free to use? What license does it have?
docmd is open source under the MIT license. Check the license terms before using it in commercial products.
Is docmd still maintained?
Actively maintained. The last commit to docmd was on Oct 16, 2026.
What can I use docmd for?
Publishing project documentation from an existing Markdown folder with no setup Giving LLMs and coding agents structured context from your docs Migrating an existing Docusaurus, VitePress or MkDocs site Hosting multilingual API documentation on any static host
How do I install docmd?
Point docmd at a Markdown folder and start the dev server: npx @docmd/core dev Build a static site for deployment: npx @docmd/core build
Where can I get docmd?
The source code and installation instructions are on GitHub: https://github.com/docmd-io/docmd

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects