Tau Docs Kit · Material for MkDocs on Taubyte
Documentation that ships with the cloud¶
This is a full documentation product template — not a single-page shell. It mirrors the structure of the Nextra docs template (sidebar, nested Advanced section, theme toggle, search, about/contact) and runs as static HTML on Taubyte, with live HTTPS APIs for versions and feedback.
Why MkDocs Material (not Nextra) on Taubyte¶
Taubyte websites serve whatever lands in /out after .taubyte/build.sh. That favors true static generators.
| Option | Fit for Taubyte | Notes |
|---|---|---|
| Material for MkDocs | Excellent | Client-side search, dark mode, TOC, tabs, admonitions — all static |
| VitePress / Docusaurus | Good | Static export works; heavier Node toolchain |
| Nextra | Awkward | Needs Next.js output: 'export' + Pagefind; loses Next server features |
We chose Material for MkDocs so every docs UX feature works out of the box on aventr without a Node SSR runtime.
Feature checklist (all enabled)¶
Navigation¶
Tabs, sections, sticky path crumbs, instant loading, footer prev/next, back-to-top.
Search¶
Built-in lunr search with suggest, highlight, and share — no Algolia required.
Reader UX¶
Light / dark / system themes, code copy, tabbed examples, admonitions, task lists, footnotes, Mermaid.
Live cloud¶
GET /api/health, GET /api/versions, POST/GET /api/feedback backed by a Taubyte KV database.
Example content map¶
- Introduction — what this kit is and how docs are organized
- Getting started — quickstart, layout, deploy to aventr
- Another page — standalone page like the Nextra sample
- Advanced/ — functions, databases, websites, “Satori” deep-dive folder
- Reference — HTTP API + CLI cheatsheet
- Live APIs — click-to-call demos against this same domain
- About / Contact — project meta + external links
Open two tabs
Leave Live APIs open while you read — versions load from the real /api/versions function on this host.