docmd features a modular architecture that separates file system operations from core processing logic. This allows the documentation engine to run entirely in the browser, enabling live editors and CMS previews without a server.

Open Live Editor

The Live Editor

The built-in Live Editor provides a split-pane interface where you can write Markdown on the left and see the rendered documentation on the right instantly.

Running Locally

Launch the editor on your machine:

docmd live

Static Deployment

Generate a standalone version for hosting (e.g., on Vercel or GitHub Pages):

docmd live --build-only

This creates a dist/ directory containing the index.html and docmd-live.js engine.

---

Embedding docmd in Your Site

Use the browser-compatible bundle to add Markdown preview capabilities to your own applications.

1. Include Script and Assets

<link rel="stylesheet" href="/assets/css/docmd-main.css">
<link rel="stylesheet" href="/assets/css/docmd-theme-sky.css">
<script src="/docmd-live.js"></script>

2. Using the API

The global docmd object exposes the compile function.

const html = docmd.compile(markdown, {
  siteTitle: 'My Live Doc',
  theme: { name: 'sky' }
});

document.getElementById('preview-frame').srcdoc = html;