Reference Badge
Show off your reference quality. Add a badge to your README to display your health score. Every badge links back to your project pages.
Choose Your Style
Customize Your Badge
Preview
Markdown
[](https://automadocs.com/docs/your-username/your-repo)HTML
<a href="https://automadocs.com/docs/your-username/your-repo"><img src="https://automadocs.com/badge/your-username/your-repo" alt="Code Reference"></a>reStructuredText
.. image:: https://automadocs.com/badge/your-username/your-repo
:target: https://automadocs.com/docs/your-username/your-repo
:alt: Code ReferenceHow It Looks in Your README
your-username/your-repo
A well-documented project with solid guides and API references.
Why Add a Documentation Badge?
Signal Quality
Show contributors and users that your project takes documentation seriously.
Track Progress
Your badge updates automatically as your documentation health score changes.
Drive Adoption
Projects with good docs get more contributors. The badge proves yours are maintained.
Badge Implementation Tips
Keep badge usage consistent across repositories so contributors can quickly assess project quality and documentation status from the first screen.
Place Near the Top
Put the badge close to your project title with build and test badges so it is visible before users scroll.
Link to Live Docs
Always point the badge to your current documentation URL so visitors can verify examples and onboarding steps immediately.
Review Monthly
Check styling and label clarity during regular maintenance so badge states stay understandable for new contributors.
When Badge Metrics Actually Help
A badge is most useful when it reflects a real review workflow. If coverage or health values are ignored by maintainers, the indicator becomes decoration. Tie badge changes to regular checks during release prep so contributors can trust what they see.
Set Clear Thresholds
Define what counts as healthy for your project and document those thresholds in your contributing guide.
Review Drift
Track sudden score drops after large refactors and resolve missing docs before onboarding quality degrades.
Keep Labels Simple
Use short, plain labels so first-time contributors can understand status without reading extra project context.