TiredDocs

TiredDocs is a docs toolkit for existing Vite + Vue applications. It turns a folder of .mdx files into localized docs routes, a content graph, and a default docs shell without forcing integrators to hand-wire the boring pieces.

Public Packages

Package	Audience	Stable entrypoints
@tireddocs/cli	app developers onboarding TiredDocs into an existing project	package root, tireddocs bin
@tireddocs/vite-plugin	app developers wiring docs content into Vite	package root
@tireddocs/mdx	source-layer and content-graph integration	package root, @tireddocs/mdx/config
@tireddocs/ui	Vue runtime, default theme, and MDX blocks	package root, @tireddocs/ui/primitives, @tireddocs/ui/presets/default, @tireddocs/ui/styles.css
@tireddocs/core	low-level route, graph, and search primitives	package root, @tireddocs/core/negotiation

Supported Path

1. Run pnpm dlx @tireddocs/cli init inside an existing Vite + Vue app.
2. Let the CLI create source.config.ts, docs/, mdx-components.ts, and tireddocs.json.
3. Use @tireddocs/vite-plugin to build the docs graph and virtual modules.
4. Use @tireddocs/ui to mount docs routes and the default docs shell.

i18n Boundary

TiredDocs owns locale-aware docs routes, fallback resolution, localeLinks, and localized labels for the built-in docs UI.

TiredDocs does not ship a built-in language switch as part of the default theme contract. If a product needs language switching UI, the host app should implement it through its own i18n layer.