Site-level configuration for the euv-docs demo home page

(consumed by build.rs when EUV_DOCS_SRC_DIR is unset, e.g.

during cargo clippy / cargo test in the euv-docs crate itself).

site: title: euv-docs description: A documentation site generator powered by euv + euv-ui. logo: '📘' locales:

• prefix: /

  Content directory under docs/docs/. Required: the build refuses to

  guess a locale's content location, and fails loudly when it is empty

  instead of emitting a one-page site.

  dir: en lang: en-US label: English title: euv-docs description: A documentation site generator powered by euv + euv-ui. footer: MIT Licensed | Built with euv + euv-ui toc_label: On this page prev_label: Previous next_label: Next navbar:
  • { text: Home, link: / }
  • { text: Guide, link: /guide/ }
  • { text: GitHub, link: https://github.com/euv-dev/euv }

euv-docs

A documentation site generator built with euv + euv-ui, compiled to WebAssembly.

Write markdown in any directory containing a README.md — get a full docs site with a home title block, navbar, multi-level collapsible sidebar, right anchor TOC, prev/next links, footer, dark mode, and i18n.

Quick start

cargo install euv-cli

# dev server with hot reload (run from this directory)
euv run --dev --port 8080 --index-html docs/template.html -- --target web --out-dir www/pkg --out-name euv_docs --no-typescript --no-pack

# production build → www/
euv build --release --index-html docs/template.html -- --target web --out-dir www/pkg --out-name euv_docs --no-typescript --no-pack

Open http://localhost:8080 after euv run.

Writing docs

• Site config (title, locales, navbar, footer, labels) — cli/README.md frontmatter (single source of truth, replaces the legacy docs/config.toml).
• Sidebar — auto-generated from the file tree; order with frontmatter order: <int>.
• Directory without an index page — set index: false in the directory's README.md frontmatter: the page is not rendered (the route 404s like a directory without a README) and the sidebar group keeps the README title but only toggles its children instead of navigating.
• Home page — frontmatter home: true + heroText / tagline / actions / features / footer.
• Static assets — put them in cli/docs/public/, reference as /logo.png.

Building a site from any markdown directory

The euv-docs binary builds any directory containing a top-level README.md (with site config in its frontmatter) plus **/*.md content files into a static site. Use this to ship documentation for a project without modifying euv-docs itself.

cargo install --path docs --bin euv-docs

euv-docs <SRC_DIR> [--out <OUT_DIR>] [--name <NAME>] [--index-html <FILE>] [--debug]

Crate structure

docs/
├── src/
│   ├── bin/docs/          CLI entry: arg parsing, build orchestration
│   ├── component/         Site layout components
│   │   ├── doc_page/      Router-level home / doc / 404 switch
│   │   ├── home_page/     Title block + feature grid + footer
│   │   ├── layout/        Navbar + sidebar shell
│   │   ├── not_found/     404 page
│   │   └── password_gate/ Private page protection
│   ├── data/              Generated `DocsSite` types (consumed by `build.rs`)
│   ├── router/            Hash-route parser / link handler
│   └── lib.rs             WASM entry: inject global styles, mount app
├── build.rs               Codegen `docs_gen.rs` from `**/*.md` + README frontmatter
├── template.html          Default `<base href="./">` shell
├── Cargo.toml             `[package] euv-docs`, `euv = "0.18"` pin (CSS safe-area)
└── docs/                  (this crate ships demo content only — real docs
                           live at `cli/docs/`)