Skip to main content

Introducing the oxdoc Project

· One min read
Jihoon Lee

API documentation generation in the TypeScript/JavaScript ecosystem has long suffered from performance issues.

TypeDoc is a great tool, but because it depends on the TypeScript Compiler, it experiences OOM crashes and severe performance degradation in large projects.

oxdoc is a project that aims to fundamentally solve this problem by leveraging the OXC parser (Rust NAPI).

Goals​

  1. Blazing-fast JSDoc/TSDoc extraction powered by OXC parser
  2. Documentation coverage checks (CI integration)
  3. Doc test - automatic @example block validation
  4. Multiple output formats: JSON, Markdown, HTML, llms.txt

We will share progress updates on this blog.