Mosaic Documentation

Static HTML documentation for Paimon Mosaic.

Local Preview

Serve the docs locally with any static file server:

# Python
cd docs
python3 -m http.server 8090

# Node.js (npx)
npx serve docs

Then open http://localhost:8090 in your browser.

Structure

docs/
├── index.html        # Home page (overview, benchmarks, types)
├── design.html       # Format specification & binary layout
├── rust-api.html     # Rust API guide
├── java-api.html     # Java API guide
├── python-api.html   # Python API guide
├── cpp-api.html      # C++ API guide
├── css/
│   └── style.css     # Styles (light/dark theme)
└── js/
    └── main.js       # Theme toggle & mobile menu

No Build Step Required

The documentation is plain HTML/CSS/JS with no build toolchain. Edit the HTML files directly and refresh the browser to see changes.

Fonts are loaded from Google Fonts CDN (DM Sans and JetBrains Mono). An internet connection is needed for fonts to render correctly during local preview.