dossiers
| Crates.io | dossiers |
| lib.rs | dossiers |
| version | 0.5.0 |
| created_at | 2025-12-17 12:47:24.561022+00 |
| updated_at | 2026-01-24 09:02:07.620324+00 |
| description | Dossiers: A home for your specs, policies, and process docs |
| homepage | https://dossie.rs |
| repository | https://github.com/dossie-rs/cli |
| max_upload_size | |
| id | 1990111 |
| size | 3,083,621 |
Robert Lillack (roblillack)
documentation
README
Dossiers
[!CAUTION]
Dossiers is currently in active development. Features and APIs may change.
The Dossiers CLI is a command-line tool for turning a specification repository into a static, navigable website.
It takes a directory of Markdown (or AsciiDoc, preliminary support only) files and produces a fully rendered site with structured navigation and search, making it easy to publish internal documentation, specifications, or policies without running a full-blown server.
The CLI can be used on its own to generate static sites, or alongside Dossiers to preview documentation locally in development workflows.
Typical use cases:
- Preview documentation changes locally before merging
- Generate static documentation sites for internal or offline use
- Publish specs, process docs, or policies from a Git repository
- Integrate documentation builds into CI pipelines
Diagram support
Markdown fences using mermaid (and AsciiDoc source blocks such as
[source,mermaid]) are rendered client-side with Mermaid.js. ASCII diagrams
using svgbob (for example ```svgbob in Markdown or [source,svgbob] in
AsciiDoc) are rendered server-side into SVG during spec processing.
To update the Mermaid runtime:
./scripts/update-mermaid.sh <version>
This refreshes assets/mermaid.min.js and records the version in
assets/mermaid.version.
For more information, visit the Dossiers website at https://dossie.rs