Skip to main content

​
Doctor Doom Making Docs

A comprehensive documentation tool designed for modern teams. Build beautiful documentation sites with multilingual support, API references, and seamless PDF exports.

​
Key Features

AI-Powered Translation

Automatically translate your documentation into multiple languages using AI

Auto-Generated Sidebar

Smart sidebar generation based on your file structure and frontmatter

API Documentation

Generate API docs from OpenAPI specs and Kubernetes CRDs

PDF Export

Export your documentation to beautifully formatted PDF files

MDX Support

Write content in Markdown or MDX with React component support

Mermaid Diagrams

Built-in support for Mermaid diagrams and visualizations

Hot Reloading

Fast development workflow with instant preview updates

Extensible Plugins

Powerful plugin system for custom functionality

​
Quick Start

1

Install Doom

Install the Doom CLI using your preferred package manager
npm
npm install -D @alauda/doom typescript
yarn
yarn add -D @alauda/doom typescript
pnpm
pnpm add -D @alauda/doom typescript
2

Initialize Your Project

Create your documentation structure and configuration file
mkdir -p docs/en docs/zh
echo '# Hello World' > docs/en/index.md
echo 'title: My Docs' > doom.config.yml
3

Start Development Server

Launch the development server and start writing
npx doom dev

​
CLI Commands

doom dev

Start the development server with hot reloading

doom build

Build your documentation for production

doom new

Create new documentation from templates

doom translate

Auto-translate documentation to other languages

doom export

Export documentation to PDF format

doom lint

Lint your documentation for errors

​
Learn More

Configuration

Learn how to configure Doom for your needs

Project Structure

Understand the recommended file organization

Deployment

Deploy your documentation site to production

Build docs developers (and LLMs) love

Get started for freeTalk to us