Status Badge
Embed a live documentation status badge in your README.
Pith exposes an SVG badge endpoint that reflects the status of the latest run for a given repository. The badge updates automatically - no cache busting required.
| State | Colour | Label |
|---|---|---|
| Latest run succeeded | Green | docs: up to date |
| Latest run failed | Red | docs: failed |
| No runs yet | Grey | docs: no runs |
Embed in your README
Find your repository ID in the dashboard URL (/dashboard/repos/[repoId]) and use it below:
Markdown
HTML
<img src="https://app.pith.dev/api/badge/<repoId>" alt="Pith docs status" />Ready to stop writing docs by hand?
Connect your first repository and Pith will handle the rest.