Git-based workflow

Dossiers treats specifications like code. Store your docs in Git, open pull requests for changes, review them with your team, and merge when ready. Every change is tracked, every decision is documented, and everyone has a read-only view of the current state.

  • Full version history for every specification
  • PR-based review workflow with inline comments
  • Integration with your existing development tools
  • Portable — your data stays in Git, not locked in a proprietary system

Zero configuration

Just add your Markdown files to a directory and run dossiers serve. No configuration files, no theme selection, no navigation setup. Dossiers automatically:

  • Generates an index of all specifications
  • Creates a table of contents for each document
  • Detects and displays pull requests
  • Extracts metadata from frontmatter
  • Renders beautiful, responsive pages

Beautiful, responsive design

Every page is designed to be readable and accessible on any device:

  • Automatic dark mode — respects system preferences with manual override
  • Table of contents — sticky sidebar navigation for long documents
  • Syntax highlighting — code blocks with proper formatting
  • Responsive typography — optimized for readability at any screen size
  • Cross-document links — easy navigation between related specs

Full-text search

Find what you need instantly. The hosted service includes powerful full-text search across all your documents. Search by keyword, phrase, or metadata field. Results are ranked by relevance and highlight matching content.

Authentication & access control

When using the hosted service, you can restrict access to your specifications:

  • Google Workspace — limit access to anyone with an email in your domain
  • GitHub organizations — restrict to members of your GitHub org
  • Public — make your specs available to everyone (great for open source projects)

Pull request integration

Dossiers automatically detects open pull requests in your repository and displays them alongside published specs. This makes it easy to see what's in progress and review specifications before they're merged.

Flexible metadata

Add custom metadata to your specifications using YAML frontmatter. Dossiers supports standard fields like status, authors, and dates, plus any custom fields you need for your workflow. All metadata is searchable and can be displayed on spec pages.

Host anywhere

Generate static sites that can be hosted on any platform: GitHub Pages, Netlify, Vercel, your own CDN or web server, or internal company infrastructure.

Or use the hosted service at dossie.rs for zero-infrastructure deployment with built-in authentication and search. See the deployment guide for details.

Ready to try Dossiers?

Get started with the community edition or explore the hosted service.