Skip to main content

Comparison with Other Tools

How does oxdoc compare with other TypeScript/JavaScript documentation tools?

Feature Comparison

FeatureoxdocTypeDocJSDocdocumentation.jsdeno docESDoc
TypeScript supportYesYesNoPartialYesNo
JSDoc extractionYesYesYesYesYesYes
Doc coverageBuilt-inPluginNoNoNoBuilt-in
Doc testingBuilt-inNoNoNoNoNo
Coverage badge (SVG)Built-inPluginNoNoNoNo
API diff / change detectionBuilt-inNoNoNoNoNo
HTML outputYesYesYesYesYesYes
Markdown outputYesNoNoYesNoNo
llms.txt (AI-friendly)YesNoNoNoNoNo
JSON outputYesYesNoYesYesNo
Source links in HTMLYesYesNoNoYesNo
Plugin systemYesYesYesNoNoYes
Watch modeYesYesNoNoNoNo
Native speed (Rust)YesNoNoNoYesNo
Actively maintainedYesYesYesLowYesNo

Performance Comparison

vs TypeDoc

TypeDoc relies on the full TypeScript Compiler (tsc), which means it loads the entire type system, resolves all type references, and builds a complete program graph. This gives TypeDoc deep type information but comes at a significant performance cost.

oxdoc uses OXC parser (Rust NAPI) for syntax-only parsing — no type checking, native Rust execution, and batch processing for memory efficiency.

Measured on macOS (Apple Silicon), Node.js v22, median of 3 runs. TypeDoc 0.28 with --skipErrorChecking.

Metric (es-toolkit, 603 files)oxdocTypeDoc 0.28Speedup
JSON Generation0.24s1.70s7x faster
HTML Generation0.25s2.53s10x faster
Peak Memory131MB470MB3.6x less
Metric (radashi, 162 files)oxdocTypeDoc 0.28Speedup
JSON Generation0.13s1.12s8.6x faster
Peak Memory84MB272MB3.2x less

vs JSDoc

JSDoc is the classic documentation generator for JavaScript. It doesn't support TypeScript natively and lacks modern features like documentation coverage checking and doc testing. Performance is moderate for JavaScript-only projects.

vs deno doc

deno doc is also Rust-based (uses SWC internally) and offers comparable parsing speed. However, it lacks:

  • Documentation coverage measurement
  • Doc testing
  • Coverage badge generation
  • API change detection
  • Plugin system
  • Multiple output formats (Markdown, llms.txt)

vs ESDoc

ESDoc was one of the few tools with built-in documentation coverage, but the project is no longer maintained (last significant update was years ago). It only supports JavaScript, not TypeScript.

When to Use What

Use CaseRecommended Tool
Large TS/JS projects needing speedoxdoc
Need deep type resolution & inferenceTypeDoc
JavaScript-only, legacy projectsJSDoc
Deno projectsdeno doc
Angular/NestJS projectsCompodoc
CI doc quality gates (coverage + testing)oxdoc
API change detection in PRsoxdoc
AI/LLM-optimized documentationoxdoc

What TypeDoc Does Better

To be fair, TypeDoc has advantages in specific areas:

  • Deep type resolution — TypeDoc resolves type aliases, follows imports, and expands complex types. oxdoc extracts signatures as-written in source code.
  • Mature plugin ecosystem — TypeDoc has a large ecosystem of community plugins.
  • Cross-file type linking — TypeDoc can link type references across files.

These trade-offs are by design: oxdoc prioritizes speed and simplicity over type-system depth.