Skip to content

Badge Catalog

docs/badges.md is the single source of truth for shared badge templates across the managed documentation surfaces in this repository. Update the named templates here, then run make sync-badges so the root README, the docs landing page, and the managed package README surfaces publish the same badge contract.

Do not hand-edit badge blocks inside managed surfaces. Those files consume the templates below through generated badge sections.

If a README surface needs package links outside the managed badge section, use plain markdown links or icon links instead of inline badge markdown.

Generated badge sections always render in this order:

  1. surface summary badges when the surface owns them
  2. one line of PyPI badges for every public package
  3. one line of GHCR badges for every public package
  4. one line of Documentation badges for every public package

Link policy for GHCR badges is fixed here as part of the contract:

  • the repository-wide GHCR summary badge links to https://github.com/bijux?tab=packages
  • per-package GHCR badges link to the package-specific https://github.com/bijux/bijux-proteomics/pkgs/container/... page

Repository Summary

Python 3.11+ License: Apache-2.0 Verify Publish Docs Release GHCR packages Published packages

Package Summary

Python 3.11+ Typing: typed License: Apache-2.0 CI Status GitHub Repository

Maintainer Summary

Python 3.11+ License: Apache-2.0 Verify Publish Docs

Family PyPI Badge

{{ distribution_name }}

Family GHCR Badge

{{ distribution_name }}

Family Docs Badge

{{ docs_badge_alt }}