Diagrams as code, documents as PDF
Mermaid lets you describe diagrams in plain text, which makes them easy to version, review and update. The catch is sharing them with people who don’t live in a Markdown viewer. Exporting the whole document to PDF solves that: architecture notes, runbooks and project plans become a single file anyone can open.
Supported diagram types
- Flowcharts for processes and architecture
- Sequence diagrams for APIs and user flows
- State and class diagrams for system design
- Entity-relationship diagrams for databases
- Gantt charts and timelines for planning
- Pie charts and mindmaps for quick summaries
Layout tips
- Keep labels short — long labels make diagrams wide.
- Prefer top-to-bottom (
TB) layouts in portrait pages. - Put each large diagram after a heading so it starts cleanly on a page.