DEV Community

Cover image for Is docmd the fastest way to ship docs? An honest look at the new v0.4 release.
Adam Makins
Adam Makins

Posted on

Is docmd the fastest way to ship docs? An honest look at the new v0.4 release.

We are spoiled for choice with documentation generators. Docusaurus, MkDocs, VitePress... do we really need another one?

I recently took docmd (specifically the new v0.4.0 monorepo release) for a spin to document a small Node.js library. The promise is "Zero Config" and "Static HTML."

Here is my honest take on where it shines, where it falls short, and who should use it.

πŸ‘πŸΌ The Good Stuff

1. Actually Zero Config
You run docmd init, then docmd build. That’s it. You get a site/ folder ready for Netlify or GitHub Pages. There is no complex config file unless you want to change defaults.

2. The "Live" Architecture
This is the coolest technical feature. Because the core engine is isomorphic, the docmd live command opens a browser-based editor that renders changes instantly. It doesn't feel like a "hot reload" (which takes 500ms+); it feels like typing in a native app.

3. Built-in Offline Search
Most static site generators force you to set up Algolia DocSearch. That involves applying for an account, setting up API keys, and configuring CI crawlers.
docmd generates a search-index.json locally. Search works out of the box, is privacy-friendly, and works offline.

4. AI Readiness
It automatically generates an llms.txt file. If you use tools like Cursor or ChatGPT to query your own docs, this is a massive quality-of-life feature that I haven't seen standard in other tools yet.

πŸ‘ŽπŸΌ The "Fallbacks" (Areas for Improvement)

1. No MDX (Yet)
If you are coming from Docusaurus, you might be used to importing React components directly into your Markdown files (MDX). docmd is strict Markdown + HTML. You cannot import a <Counter /> component. If you need complex interactivity inside your docs, stick to React-based generators.

2. Theming Limitations
The built-in themes (Sky, Retro, Ruby) are nice, and you can inject custom CSS. But there isn't any robust "Theme Builder" UI yet. If you want to drastically change the layout (e.g., move the sidebar to the right), you'll be writing raw CSS overrides.

3. Ecosystem Size
It’s a newer tool. The plugin system is fresh (from what I see, just recently introduced in v0.4+). While it has the essentials (SEO, Analytics, Mermaid, Sitemap), it doesn't have the massive plugin library of MkDocs or Gatsby, although it's a little early to say how the whole ecosystem evolves.

πŸ˜‡ My Opinion

docmd has carved out a specific niche: Performance and Simplicity.

  • Use docmd if: You are a library author, you hate configuring build tools, or you want a site that loads instantly on 3G networks because it sends zero JavaScript bloat to the client.
  • Stick to Docusaurus if: You are building a massive enterprise site that needs versioning dropdowns for 10 different software versions, or if you need MDX interactivity.

For my personal projects and NPM packages? I’m switching to docmd. The speed of the workflow is just addictive.

If you want to give it a go:
https://docmd.io

Top comments (0)