Skip to content

Working on this website

Run, edit, validate and export the Nuxt documentation site.

On this page

Run the website

From the Inrux repository root:

sh
pnpm --dir docs install --frozen-lockfile
pnpm --dir docs dev

Use Node.js 22.19 or newer. The site uses the published @igrislabs/indocio Nuxt layer. It does not need the local Indocio checkout, Rust GUI engines or a hosted database.

Edit a page

Write Markdown in docs/content/. Numeric prefixes set sidebar order and do not appear in URLs. Leave component page filenames unnumbered so the sidebar sorts them alphabetically. Each page has title and description frontmatter. .navigation.yml names a section. content/index.yml supplies the landing-page copy.

Keep an API claim tied to checked-in code. Each component Usage section must contain a complete src/App.iru with view, Rust and scoped-style blocks, including its state and handlers. Smaller API fragments can follow the runnable example when they are labeled as fragments. Use working .iru examples and separate supported features from proposals. Update internal links when moving pages; the site test checks route targets.

App-level changes live in docs/app/. app.config.ts supplies navigation and documentation layout. The brand component and bundled fonts come from this repository. The layer owns search, Markdown rendering, keyboard controls and responsive navigation. A small local code-block override keeps highlighted examples keyed by their source across page changes. A small DocsSidebar wrapper reveals the active item after sidebar hydration, page navigation and mobile drawer opening without moving the document. Installation instructions use the layer's tabs / tab-item components for macOS, Linux and Windows.

Check and build

sh
pnpm --dir docs test
pnpm --dir docs typecheck
pnpm --dir docs build

The public documentation origin is https://inrux.igrislabs.com. Canonical URLs, Open Graph assets and the sitemap use it by default. Set NUXT_SITE_URL before building to override the origin for a separate deployment. Static output goes to docs/.output/public/. Serve that directory on a static host. The nitro.preset: "static" setting in nuxt.config.ts makes the standard nuxt build command produce a static site. Both pnpm --dir docs build and pnpm --dir docs generate prerender linked pages to HTML and fail on rendering errors. Production does not need a Node server. Use pnpm --dir docs preview to preview the static build.

Run python3 docs/scripts/check-examples.py from the repository root after editing component usage examples. This check requires Rust and native build prerequisites. It uses the CLI starter, compiles each pasted App.iru with egui and the optional Markdown feature, and validates its initial component description. It does not launch a window or replace native interaction tests.

The content and build tests cover route integrity and generated output. Check search, keyboard navigation, mobile navigation, theme switching and copy buttons in a browser before publishing. No hosting or deployment runs as part of this setup.

Inrux · Built with Nuxt Content, IPEX, and Akaza UI.