Add badges to GitHub README - #31
Merged
Merged
Conversation
…ws example This section documented auto-detection as if it were a new feature — it's now just how the package works. The table of row counts is redundant with the head() output shown immediately after in the workflow.
Three rows of centered badges mimicking CausalPy's layout: - Row 1: PyPI version, MIT license, Python versions - Row 2: CI, Ruff, pre-commit - Row 3: GitHub Stars, total downloads, monthly downloads Includes <!-- docs-start --> marker so great-docs strips the GitHub-only badge section when building the docs site.
drbenvincent
added a commit
that referenced
this pull request
Jul 9, 2026
PR #31 placed the first badge row directly under <div align="center"> with no blank line. GitHub's CommonMark renderer treats content adjacent to an HTML block tag as raw HTML, so the PyPI/License/Python badges displayed as literal text instead of rendering. The other rows rendered because they had blank lines above them.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Three rows of centered badges mimicking CausalPy's layout:
Includes
<!-- docs-start -->marker so great-docs strips the GitHub-only badge section when building the docs site.