What Ox Content Is#
Ox Content is a Rust-powered document generator and high-performance Markdown processing toolkit for JavaScript and TypeScript projects.
If you want the shortest explanation, it is best understood as cargo doc for JavaScript with a Vite-native workflow.
It also works as a framework-agnostic documentation pipeline with extra batteries included: built-in OG image generation, full-text search, theming hooks, API doc generation, and a reusable content engine.
The site output is zero-JavaScript-first and MPA-oriented by default, so the baseline experience stays fast and simple. When you do need interactivity, Ox Content can hydrate islands and integrate with Vue, Svelte, and React.
Under the hood, Ox Content is not only a docs theme. It also exposes the Markdown parser, renderer, transforms, and plugin system as reusable pieces, so you can use it as a Markdown library outside the default site generator.
Why It Is Fast#
- Implemented in Rust with arena-based allocation and zero-copy parsing where possible
- Designed to reuse ideas and ecosystem conventions that feel natural alongside the VoidZero family
- Optimized for static, cache-friendly multi-page output instead of assuming a heavy client runtime
Integrations#
- Vue Integration Example - Embed Vue components in Markdown
- React Integration Example - Use React islands inside Markdown pages
- Svelte Integration Example - Bring Svelte components into the same pipeline
User Guide#
- 日本語ドキュメント — ガイドと組み込み機能の日本語
- Getting Started - Installation and first steps
- Built-in Features - Defaults, opt-in features, embeds, emoji shortcodes, and code annotations
- Theming - Customize your documentation site
- Examples - Integration, source docs, OG image, and SSG examples
- Credits - Community credits and contribution summaries
Advanced Docs#
- Architecture - Deep dive into the design
- Performance - Benchmark results and reproduction commands
- Profiling Mode - Allocation and span-level investigation
- unplugin mdast Bridge Example - Native parser plus unified-compatible mdast plugins
- unplugin markdown-it Token Bridge -
markdown-itplugins plus downstream unified token access - Development Setup - Build ox-content itself and work on the repo
- Release Operations - Cut releases, recover failed publishes, and handle first-time crates
- Docs Deployment - Deploy the documentation site to Void with
vp run deploy#docs - Editor Extension Roadmap - VS Code and Neovim plan, PR-by-PR
- Code Play Roadmap - Opt-in
@ox-content/code-playplugin plan - Ox Content 3.0 Roadmap - Theme packages, MDX, Code Play, built-ins, tree-sitter highlighting
- Docs Site Feature Roadmap - Opt-in built-in docs-site features
Reference#
- API Reference - Generated API docs for the public surface
- Vite Plugin - Main docs pipeline package
- Packages - Node.js, WebAssembly, framework, and i18n package docs
- GitHub - Source code and issues
Community Credits#
Special thanks to kazupon for substantial community contributions around JSDoc support, including the API docs generation pipeline and documentation quality.
See Credits for the contribution summary.
Sponsor#
If you find Ox Content useful, please consider sponsoring the project.