Skip to content

Guides

Each guide reaches one goal in a real project, and assumes you have done Get started.

Goal Guide
Fail a pull request that adds an unreadable diagram Gate diagrams in CI
Switch a rule off, change the density preset, or set rule options Configure the rules
Score diagrams the way a Material theme renders them Lint a MkDocs Material site
Add a rule for your own project in one file Write a local rule
Share rules between projects as an npm package Publish a plugin package
Stop a commit that adds an unreadable diagram Check diagrams before each commit
Get past a common error or question Troubleshooting