Free for all repos

Documentation Badge

Show off your docs quality. Add a badge to your README to display your documentation health score. Every badge links back to your docs.

Choose Your Style

Customize Your Badge

Preview

docsdocspassingpassing

Markdown

[![Documentation](https://automadocs.com/badge/your-username/your-repo)](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="Documentation"></a>

reStructuredText

.. image:: https://automadocs.com/badge/your-username/your-repo
   :target: https://automadocs.com/docs/your-username/your-repo
   :alt: Documentation

How It Looks in Your README

README.md

your-username/your-repo

docsdocspassingpassingbuildpassing

A well-documented project with comprehensive 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.