Ox Content

High-performance Markdown toolkit

A framework-agnostic document generator and high-performance Markdown toolkit for the Vite era, with OG images, theming, search, Rust speed, and zero-JavaScript-first MPA output.

Get Started View on GitHub Sponsor

Unofficial project notice

This project is not an official VoidZero product.

ubugeeei is building ox-content as an unofficial proposal, hoping it could someday be adopted as vp doc.

The current branding and visual references are unofficial fan work and will be revised or taken down if VoidZero or the relevant rights holders ask.

API Docs from JSDoc

Generate docs for JavaScript and TypeScript projects with a docs.rs-like bias, plus first-class Markdown pages.

Framework Agnostic, Vite Native

A framework-agnostic pipeline with built-in OG image generation, search, theming, API docs, and content processing.

Rust + VoidZero DNA

Implemented in Rust for speed and built to feel at home in the Vite, Oxc, Rolldown, and Vitest ecosystem.

Zero-JavaScript-First MPA

Ships as a fast multi-page app by default, then adds JavaScript only where islands or interactive features actually need it.

High-Performance Markdown Engine

The parser, renderer, and plugin system are reusable as a Markdown library, not just internals behind the default docs theme.

Vue, Svelte, React Integrations

First-party integrations let you embed framework components into Markdown without giving up the core pipeline.

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-it plugins 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

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.

If you find Ox Content useful, please consider sponsoring the project.