Skip to main content
Powered by OXC (Rust)

API docs at
native speed

Blazing-fast TypeScript/JavaScript API doc generator powered by OXC parser. JSDoc extraction, coverage checks, and doc testing in one tool.

$ npx @jiji-hoon96/oxdoc coverage ./src --threshold 80

Documentation Coverage Report
Total symbols: 42
Documented: 35 (83.3%)

Coverage 83.3% meets threshold 80%

Everything in one tool

Generate docs, check coverage, and test examples — fast

OXC Native Parsing

7-10x faster than TypeDoc (measured). Processes 5,000 files in under 1 second via Rust NAPI.

📊

Doc Coverage

Measures JSDoc coverage of exported symbols. Fail CI builds when coverage drops below threshold.

🧪

Doc Test

Executes @example code blocks to automatically verify that documentation stays in sync with code.

🤖

llms.txt Output

Auto-generates AI/LLM-optimized docs. Helps Copilot, Claude, and others understand your library accurately.

🔌

Plugin System

Extensible with 3 hooks: Transform, Output, and Analyzer. Add custom output formats and analysis rules.

👁

Watch Mode

Detects file changes and auto-regenerates docs. Preview documentation in real-time during development.

Benchmarks

Real performance comparisons against TypeDoc

JSON Generation
oxdoc
0.24s
TypeDoc
1.70s
7x faster
HTML Generation
oxdoc
0.25s
TypeDoc
2.53s
10x faster
Peak Memory
oxdoc
131MB
TypeDoc
470MB
3.6x less

Measured on es-toolkit (603 source files). Run your own benchmarks with: pnpm bench

Ready to generate docs at native speed?

npx @jiji-hoon96/oxdoc generate ./src --format html
Read the docs