Quick Start Your Docs 🚀

This is the home page of your new docmd project. You’re currently viewing docs/index.md — edit it, and your site updates.

Run the dev server

npx @docmd/core dev

Open http://localhost:3000 — the page auto-reloads as you edit.

Build for production

npx @docmd/core build

Output goes to site/. Deploy that folder anywhere that serves static files.

Project structure

.
├── docs/                  # Your markdown content
│   └── index.md           # You are here
├── assets/                # Custom CSS, JS, and images
├── docmd.config.json      # Site configuration
└── package.json           # Node dependencies + scripts

Features

1. Smart containers

::: callout tip "Did you know?"
You can nest containers, add titles, and use icons.
:::

::: card "Flexible" icon:layout-grid
Organise content with cards.

[View the docs →](https://docs.docmd.io){.docmd-button}
:::

Renders as a styled callout and a card with a button.

2. Tabs and code

::: tabs
== tab "JavaScript" icon:braces
```javascript
console.log('Hello World');
```

== tab "Python" icon:code
```python
print('Hello World')
```
:::

3. Built-in plugins

docmd ships with these plugins enabled by default — no install needed:

  • AI Assistant — interactive documentation chat (100% free with BYOK or docmd Cloud)
  • Search — full-text + semantic search (optional)
  • Sitemap + SEO meta tags
  • LLMs context — llms.txt and llms.json for AI agents
  • OKF — Open Knowledge Format bundle at site/okf/
  • Mermaid diagrams
  • Git last-modified timestamps
  • Math (KaTeX) — enable with docmd add math

See the full plugin list.

Next steps

Happy documenting! 🎉

Next Agent Skills