markdown-badges 1.0.0__tar.gz

markdown_badges-1.0.0/.gitignore

@@ -0,0 +1,6 @@
+.venv/
+dist/
+__pycache__/
+.pytest_cache/
+.ruff_cache/
+*.egg-info/

markdown_badges-1.0.0/CHANGELOG.md

@@ -0,0 +1,49 @@
+# Changelog
+
+## 1.0.0 - 2026-09-08
+
+Renamed from `markdown-priority-badges`. Breaking release: see [MIGRATING.md](MIGRATING.md).
+
+### Added
+
+- A 20-badge catalogue ships in the package and is active with no config: 6 priority, 9 status, 5 branding. `catalogue` narrows which types load, `[]` disables it.
+- `shorthand` maps any task-list marker to any badge, so anyone can invent their own markers.
+- Extended badge values: anything after a `;` in a value becomes a further CSS declaration, so a badge can carry an icon, a gradient or a shadow with no site CSS.
+- `badges_in(text)` returns every badge on a line, of any type, in document order.
+- Public API: `Badge`, `BadgeType`, `CATALOGUE`, `catalogue_for`, `resolve_badges`, `badges_in`, `priority_of`, `rank_of`.
+
+### Changed
+
+- Import path and config key are now `markdown_badges`; the CSS class prefix is `badge` instead of `task-prio`.
+- Badges are declared under `badges`, keyed by type (`priority`, `status`, `branding`), replacing the flat `levels` map.
+- `priority_of` and `rank_of` consider only `priority` badges, so a status or branding badge can no longer be reported as a severity.
+- The scanning API takes a `Mapping[str, Badge]` rather than a sequence of level names.
+
+### Removed
+
+- The `levels` option. A leftover `levels` key raises a `ValueError` pointing at the migration guide.
+- The built-in `!` / `!!` task-list shorthand. Three lines of `shorthand` config restore it.
+- `LEVELS`, `DEFAULT_LEVELS`, `level_rank`, `MARKER_RE`, `PriorityBadgesExtension`, `PriorityInlineProcessor`, `TasklistShorthandTreeprocessor`.
+
+### Fixed
+
+- A backslash-escaped keyword (`\!high`) renders as literal text instead of a badge with a stray backslash.
+- The text-contrast calculation reads a badge value up to its first `;`, so a value carrying extra declarations contrasts against its real background instead of falling back to white text.
+- Every invalid config raises a `ValueError` naming the offending key and the fix, instead of failing silently or with an `AttributeError`.
+- README links are absolute, so they resolve on the PyPI project page.
+
+## 0.2.0 - 2026-07-01
+
+### Added
+
+- Public parsing API: `LEVELS`, `level_rank(level, levels=LEVELS)`, and `priority_of(text, levels=LEVELS)` for tools that aggregate or filter task items by priority.
+
+## 0.1.0 - 2026-07-01
+
+### Added
+
+- Inline keywords: `!low` / `!medium` / `!high` / `!critical` (and any custom level) render a badge anywhere in prose, headings, or table cells. Only configured level keywords match, so an ordinary `!` in text is untouched.
+- Task-list shorthand: a leading `!` (high) / `!!` (critical) after a checkbox renders a priority badge, via a Treeprocessor running just before `pymdownx.tasklist`.
+- Configurable `levels` map (name -> color), merged over the built-in `low` / `medium` / `high` / `critical`, so levels can be recolored or added from config.
+- Self-contained styling: badges ship inline styles (no external CSS), with the text color auto-contrasted (black or white) against each background.
+- Colors accept 3- or 6-digit hex and common CSS names.

markdown_badges-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Antoine Keranflec'h
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

markdown_badges-1.0.0/MIGRATING.md

@@ -0,0 +1,55 @@
+# Migrating from markdown-priority-badges 0.2.0 to markdown-badges 1.0
+
+## Install
+
+Replace the dependency. The old project stays on PyPI at 0.2.0 and receives no further releases.
+
+```bash
+uv remove markdown-priority-badges && uv add markdown-badges
+```
+
+## Config
+
+The extension key changes, `levels` becomes `badges.priority`, and the catalogue is active by default.
+
+```toml
+# before
+[project.markdown_extensions.markdown_priority_badges.levels]
+blocker = "#7b1fa2"
+
+# after
+[project.markdown_extensions.markdown_badges.badges.priority]
+blocker = "#7b1fa2"
+```
+
+Leaving a `levels` key in place raises a `ValueError` naming this file, rather than being silently ignored.
+
+## Restoring the `!` / `!!` shorthand
+
+It is no longer built in. Three lines bring it back, and you can pick different markers.
+
+```toml
+[project.markdown_extensions.markdown_badges.shorthand]
+"!" = "high"
+"!!" = "critical"
+```
+
+## API
+
+| 0.2.0 | 1.0 |
+| --- | --- |
+| `from markdown_priority_badges import ...` | `from markdown_badges import ...` |
+| `LEVELS` | `catalogue_for(BadgeType.PRIORITY)` |
+| `DEFAULT_LEVELS` | `CATALOGUE` |
+| `level_rank(name, levels)` | `rank_of(name, badges)` |
+| `priority_of(text, levels)` | `priority_of(text, badges)` |
+| `PriorityBadgesExtension` | `MarkdownBadgesExtension` |
+| no equivalent | `badges_in(text, badges)` for every badge type |
+
+The second argument changes from a sequence of names to a `Mapping[str, Badge]`, which is what `catalogue_for` returns.
+
+`priority_of` now considers only `priority` badges, and no longer looks at a leading `!` / `!!`, because that shorthand is no longer built in.
+
+## CSS classes
+
+The class prefix changes from `task-prio` to `badge`: `class="badge badge--high"`. Update any site CSS that targeted `.task-prio`.

markdown_badges-1.0.0/PKG-INFO

@@ -0,0 +1,207 @@
+Metadata-Version: 2.5
+Name: markdown-badges
+Version: 1.0.0
+Summary: Python-Markdown extension rendering inline !name badges, with a catalogue of priority, status and branding badges
+Project-URL: Homepage, https://github.com/antoinekh/markdown-priority-badges
+Project-URL: Repository, https://github.com/antoinekh/markdown-priority-badges
+Project-URL: Issues, https://github.com/antoinekh/markdown-priority-badges/issues
+Project-URL: Documentation, https://github.com/antoinekh/markdown-priority-badges/blob/master/docs/badges.md
+Project-URL: Changelog, https://github.com/antoinekh/markdown-priority-badges/blob/master/CHANGELOG.md
+Author: Antoine Keranflec'h
+License-Expression: MIT
+License-File: LICENSE
+Keywords: badge,badges,branding,catalogue,documentation,markdown,mkdocs,priority,status,tasklist,zensical
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Framework :: MkDocs
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Documentation
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Text Processing :: Markup :: Markdown
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: markdown>=3.5
+Description-Content-Type: text/markdown
+
+# markdown-badges
+
+[![CI](https://github.com/antoinekh/markdown-priority-badges/actions/workflows/ci.yml/badge.svg)](https://github.com/antoinekh/markdown-priority-badges/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/markdown-badges)](https://pypi.org/project/markdown-badges/)
+[![Python versions](https://img.shields.io/pypi/pyversions/markdown-badges)](https://pypi.org/project/markdown-badges/)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/antoinekh/markdown-priority-badges/blob/master/LICENSE)
+
+A Python-Markdown extension that renders small inline **badges** from a `!name` keyword: priority, status, or brand. Works in Zensical, MkDocs, or plain Python-Markdown. The badge ships its own inline styles, so no external CSS is required.
+
+## Why?
+
+This is not a replacement for admonitions / callouts (`!!! warning`, `> [!NOTE]`). Those wrap a block of explanatory text. Badges are the opposite: tiny inline pills you can drop anywhere, but that fit especially nicely into a **list item, todo, or table cell**, so status or severity is scannable at a glance without turning the line into a block. The intended usage is exactly that split: reach for a callout when you have a paragraph to say, and reach for a badge to mark some rows.
+
+## Badges
+
+Write `!name` anywhere (prose, headings, table cells, list items) and it renders as a small inline pill:
+
+```markdown
+This migration is !critical and blocks the release.
+
+## !high Rotate the keys
+```
+
+![Inline badges rendered in prose and a heading](https://raw.githubusercontent.com/antoinekh/markdown-priority-badges/master/docs/img/inline-badges.png)
+
+Only a name in scope matches, so an ordinary `!`, `!important`, or `!highest` in text is never touched. To write a name literally, escape it (`\!high`) or put it in a code span (`` `!high` ``).
+
+## Badge types
+
+Every badge belongs to one of three types.
+
+| Type | Meaning | Examples |
+| --- | --- | --- |
+| `priority` | Carries a severity rank, from least to most severe. Only this type is considered by `priority_of` and `rank_of`. | `!trivial` `!low` `!medium` `!high` `!critical` `!blocker` |
+| `status` | Says where an item sits in a workflow. No rank. | `!todo` `!wip` `!review` `!blocked` `!approved` `!done` `!onhold` `!experimental` `!deprecated` |
+| `branding` | A brand mark. Most carry a logo inlined as a `data:` URI, so a page makes no network request for it; `aws` is a plain colour with no logo, because no CC0 AWS mark exists and the badge text already reads AWS. | `!gitlab` `!github` `!claude` `!docker` `!aws` |
+
+## Catalogue
+
+Every badge above ships with the package and is active out of the box, no config required.
+
+![Every badge in the catalogue, the task-list shorthand, and badges in a table and a heading](https://raw.githubusercontent.com/antoinekh/markdown-priority-badges/master/docs/img/showcase.png)
+
+Full list with keyword, value, and resolved text colour: **[docs/badges.md](https://github.com/antoinekh/markdown-priority-badges/blob/master/docs/badges.md)**.
+
+## Narrowing the catalogue
+
+The `catalogue` option is a list of type names, defaulting to all three (`priority`, `status`, `branding`). Pass a subset to load fewer of them, or `[]` to disable the catalogue entirely.
+
+```toml
+# zensical.toml
+[project.markdown_extensions.markdown_badges]
+catalogue = ["priority", "status"]   # drop the branding badges
+```
+
+```python
+# plain Python-Markdown
+from markdown_badges import MarkdownBadgesExtension
+markdown.markdown(text, extensions=[MarkdownBadgesExtension(catalogue=["priority", "status"])])
+```
+
+## Adding and recolouring badges
+
+The `badges` option is a mapping of type name to a name -> value map, merged over the catalogue: an existing name is recoloured in place, keeping its position and its type, and a new name is inserted after the last badge of its own type, so a new priority outranks every catalogue priority.
+
+```toml
+[project.markdown_extensions.markdown_badges.badges.priority]
+showstopper = "#000000"   # a new priority, ranked above every catalogue one
+critical    = "#8e0000"   # an existing name: recolours it, keeping its rank
+```
+
+```python
+from markdown_badges import MarkdownBadgesExtension
+markdown.markdown(text, extensions=[MarkdownBadgesExtension(badges={"priority": {"blocker": "#7b1fa2"}})])
+```
+
+Colors may be 3-, 4-, 6-, or 8-digit hex (`#7b1fa2`, `#eee`, `#eeeeeeff`) or a common CSS name (`red`, `yellow`, `rebeccapurple`); the badge text color auto-contrasts against them. Any alpha channel is ignored for the contrast calculation.
+
+## Extended values
+
+A badge value becomes the badge's `background-color`, so anything after a `;` becomes a further declaration on that badge. Use it to give a badge an icon, a gradient, or a shadow, with no site CSS:
+
+```toml
+[project.markdown_extensions.markdown_badges.badges.status]
+# A background image, plus the padding that makes room for it.
+icon = "#b71c1c;background-image:url('data:image/svg+xml,…');background-repeat:no-repeat;background-position:0.4em center;background-size:0.85em;padding-left:1.7em"
+# A gradient instead of a flat fill.
+gradient = "#4a148c;background-image:linear-gradient(90deg,#4a148c,#c2185b)"
+# A colored ring and halo.
+glow = "#111;box-shadow:0 0 0 2px #ff1744,0 0 10px #ff1744"
+```
+
+The contrast calculation reads the leading colour, up to the first `;`, so the badge text stays legible against the base you picked.
+
+### Custom logo badges
+
+Inline a single-path logo as a `data:` URI and you get a brand badge that costs no network request. Pick the base colour and the logo fill together: the badge text colour is chosen from the base, so a white mark needs a base dark enough to resolve to white text, and a dark mark needs a light one.
+
+```python
+import urllib.parse
+
+svg = "<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24' fill='#fff'><path d='M0 0h24v24H0z'/></svg>"
+uri = "data:image/svg+xml," + urllib.parse.quote(svg, safe="")
+value = f"#0052cc;background-image:url('{uri}');background-repeat:no-repeat;background-position:0.45em center;background-size:0.8em;padding-left:1.75em"
+```
+
+Put the resulting `value` under `badges.branding` (or any type) with the name you want the keyword to use, for example `badges={"branding": {"jira": value}}`. For the recipe used to build the shipped branding badges, including the SVG-encoding helper, see `_icon_value` in `src/markdown_badges/catalogue.py`.
+
+## Task-list shorthand
+
+Not built in by default. The `shorthand` option maps any task-list marker to any badge name, so you can pick your own markers, or restore the old `!` / `!!` behaviour:
+
+```toml
+[project.markdown_extensions.markdown_badges.shorthand]
+"!" = "high"
+"!!" = "critical"
+```
+
+```markdown
+- [ ] !blocker Waiting on vendor API access
+- [ ] !! Ship the security patch today
+- [ ] ! Review the migration PR
+- [ ] !medium Update the runbook
+- [ ] !low Tidy up log formatting
+- [x] !! Rotate the leaked credentials
+- [ ] Weekly backup check
+```
+
+<img alt="Todo list with badges" src="https://raw.githubusercontent.com/antoinekh/markdown-priority-badges/master/docs/img/todo-badges.png" width="560">
+
+The marker must come right after the checkbox and be followed by a space, so `- [ ] !important note` is left untouched. Works with `-`, `*`, `+` bullets and both `[ ]` / `[x]` states. Requires `pymdownx.tasklist` to be enabled alongside this extension.
+
+## Reusing the parser
+
+`badges_in`, `priority_of`, and `rank_of` are exposed for tools that aggregate or filter task items (for example a todo dashboard). Each takes an optional `Mapping[str, Badge]` argument, defaulting to the whole catalogue; pass the result of `resolve_badges` or `catalogue_for` to match your own config instead.
+
+```python
+from markdown_badges import badges_in, priority_of, rank_of
+
+badges_in("!blocker vendor waiting !wip")   # -> [Badge(name="blocker", ...), Badge(name="wip", ...)]
+priority_of("ping !high vendor")            # -> "high"
+priority_of("weekly backup")                # -> None (no priority badge)
+rank_of("blocker")                          # -> 5 (severity index among priority badges)
+rank_of("wip")                              # -> -1 (not a priority badge)
+```
+
+`badges_in` returns every badge found in the text, of any type, in document order. `priority_of` returns the name of the highest-ranked `priority` badge found, or `None`; `status` and `branding` badges are ignored. `rank_of` gives a badge's severity index among the priority badges, or `-1` if it has none.
+
+> [!NOTE]
+> These are plain-text scans, not a Markdown parse. Unlike the rendered badge, a keyword inside a code span or escaped as `\!high` still counts.
+
+## Install & enable
+
+```bash
+uv add markdown-badges
+```
+
+(or `pip install markdown-badges`)
+
+Zensical (`zensical.toml`):
+
+```toml
+[project.markdown_extensions.markdown_badges]
+```
+
+Plain Python-Markdown:
+
+```python
+markdown.markdown(text, extensions=["markdown_badges"])
+```
+
+Add `pymdownx.tasklist` to `extensions` too if you enable the `shorthand` option. The badge renders as `<span class="badge badge--<name>" style="...">...</span>`. The `badge` classes are kept for optional site-side overriding, but no CSS is needed by default.
+
+## Migrating from 0.2.0
+
+The package was renamed from `markdown-priority-badges` to `markdown-badges`, and the config and API changed along with it: see **[MIGRATING.md](https://github.com/antoinekh/markdown-priority-badges/blob/master/MIGRATING.md)**.

markdown_badges-1.0.0/README.md

@@ -0,0 +1,176 @@
+# markdown-badges
+
+[![CI](https://github.com/antoinekh/markdown-priority-badges/actions/workflows/ci.yml/badge.svg)](https://github.com/antoinekh/markdown-priority-badges/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/markdown-badges)](https://pypi.org/project/markdown-badges/)
+[![Python versions](https://img.shields.io/pypi/pyversions/markdown-badges)](https://pypi.org/project/markdown-badges/)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/antoinekh/markdown-priority-badges/blob/master/LICENSE)
+
+A Python-Markdown extension that renders small inline **badges** from a `!name` keyword: priority, status, or brand. Works in Zensical, MkDocs, or plain Python-Markdown. The badge ships its own inline styles, so no external CSS is required.
+
+## Why?
+
+This is not a replacement for admonitions / callouts (`!!! warning`, `> [!NOTE]`). Those wrap a block of explanatory text. Badges are the opposite: tiny inline pills you can drop anywhere, but that fit especially nicely into a **list item, todo, or table cell**, so status or severity is scannable at a glance without turning the line into a block. The intended usage is exactly that split: reach for a callout when you have a paragraph to say, and reach for a badge to mark some rows.
+
+## Badges
+
+Write `!name` anywhere (prose, headings, table cells, list items) and it renders as a small inline pill:
+
+```markdown
+This migration is !critical and blocks the release.
+
+## !high Rotate the keys
+```
+
+![Inline badges rendered in prose and a heading](https://raw.githubusercontent.com/antoinekh/markdown-priority-badges/master/docs/img/inline-badges.png)
+
+Only a name in scope matches, so an ordinary `!`, `!important`, or `!highest` in text is never touched. To write a name literally, escape it (`\!high`) or put it in a code span (`` `!high` ``).
+
+## Badge types
+
+Every badge belongs to one of three types.
+
+| Type | Meaning | Examples |
+| --- | --- | --- |
+| `priority` | Carries a severity rank, from least to most severe. Only this type is considered by `priority_of` and `rank_of`. | `!trivial` `!low` `!medium` `!high` `!critical` `!blocker` |
+| `status` | Says where an item sits in a workflow. No rank. | `!todo` `!wip` `!review` `!blocked` `!approved` `!done` `!onhold` `!experimental` `!deprecated` |
+| `branding` | A brand mark. Most carry a logo inlined as a `data:` URI, so a page makes no network request for it; `aws` is a plain colour with no logo, because no CC0 AWS mark exists and the badge text already reads AWS. | `!gitlab` `!github` `!claude` `!docker` `!aws` |
+
+## Catalogue
+
+Every badge above ships with the package and is active out of the box, no config required.
+
+![Every badge in the catalogue, the task-list shorthand, and badges in a table and a heading](https://raw.githubusercontent.com/antoinekh/markdown-priority-badges/master/docs/img/showcase.png)
+
+Full list with keyword, value, and resolved text colour: **[docs/badges.md](https://github.com/antoinekh/markdown-priority-badges/blob/master/docs/badges.md)**.
+
+## Narrowing the catalogue
+
+The `catalogue` option is a list of type names, defaulting to all three (`priority`, `status`, `branding`). Pass a subset to load fewer of them, or `[]` to disable the catalogue entirely.
+
+```toml
+# zensical.toml
+[project.markdown_extensions.markdown_badges]
+catalogue = ["priority", "status"]   # drop the branding badges
+```
+
+```python
+# plain Python-Markdown
+from markdown_badges import MarkdownBadgesExtension
+markdown.markdown(text, extensions=[MarkdownBadgesExtension(catalogue=["priority", "status"])])
+```
+
+## Adding and recolouring badges
+
+The `badges` option is a mapping of type name to a name -> value map, merged over the catalogue: an existing name is recoloured in place, keeping its position and its type, and a new name is inserted after the last badge of its own type, so a new priority outranks every catalogue priority.
+
+```toml
+[project.markdown_extensions.markdown_badges.badges.priority]
+showstopper = "#000000"   # a new priority, ranked above every catalogue one
+critical    = "#8e0000"   # an existing name: recolours it, keeping its rank
+```
+
+```python
+from markdown_badges import MarkdownBadgesExtension
+markdown.markdown(text, extensions=[MarkdownBadgesExtension(badges={"priority": {"blocker": "#7b1fa2"}})])
+```
+
+Colors may be 3-, 4-, 6-, or 8-digit hex (`#7b1fa2`, `#eee`, `#eeeeeeff`) or a common CSS name (`red`, `yellow`, `rebeccapurple`); the badge text color auto-contrasts against them. Any alpha channel is ignored for the contrast calculation.
+
+## Extended values
+
+A badge value becomes the badge's `background-color`, so anything after a `;` becomes a further declaration on that badge. Use it to give a badge an icon, a gradient, or a shadow, with no site CSS:
+
+```toml
+[project.markdown_extensions.markdown_badges.badges.status]
+# A background image, plus the padding that makes room for it.
+icon = "#b71c1c;background-image:url('data:image/svg+xml,…');background-repeat:no-repeat;background-position:0.4em center;background-size:0.85em;padding-left:1.7em"
+# A gradient instead of a flat fill.
+gradient = "#4a148c;background-image:linear-gradient(90deg,#4a148c,#c2185b)"
+# A colored ring and halo.
+glow = "#111;box-shadow:0 0 0 2px #ff1744,0 0 10px #ff1744"
+```
+
+The contrast calculation reads the leading colour, up to the first `;`, so the badge text stays legible against the base you picked.
+
+### Custom logo badges
+
+Inline a single-path logo as a `data:` URI and you get a brand badge that costs no network request. Pick the base colour and the logo fill together: the badge text colour is chosen from the base, so a white mark needs a base dark enough to resolve to white text, and a dark mark needs a light one.
+
+```python
+import urllib.parse
+
+svg = "<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24' fill='#fff'><path d='M0 0h24v24H0z'/></svg>"
+uri = "data:image/svg+xml," + urllib.parse.quote(svg, safe="")
+value = f"#0052cc;background-image:url('{uri}');background-repeat:no-repeat;background-position:0.45em center;background-size:0.8em;padding-left:1.75em"
+```
+
+Put the resulting `value` under `badges.branding` (or any type) with the name you want the keyword to use, for example `badges={"branding": {"jira": value}}`. For the recipe used to build the shipped branding badges, including the SVG-encoding helper, see `_icon_value` in `src/markdown_badges/catalogue.py`.
+
+## Task-list shorthand
+
+Not built in by default. The `shorthand` option maps any task-list marker to any badge name, so you can pick your own markers, or restore the old `!` / `!!` behaviour:
+
+```toml
+[project.markdown_extensions.markdown_badges.shorthand]
+"!" = "high"
+"!!" = "critical"
+```
+
+```markdown
+- [ ] !blocker Waiting on vendor API access
+- [ ] !! Ship the security patch today
+- [ ] ! Review the migration PR
+- [ ] !medium Update the runbook
+- [ ] !low Tidy up log formatting
+- [x] !! Rotate the leaked credentials
+- [ ] Weekly backup check
+```
+
+<img alt="Todo list with badges" src="https://raw.githubusercontent.com/antoinekh/markdown-priority-badges/master/docs/img/todo-badges.png" width="560">
+
+The marker must come right after the checkbox and be followed by a space, so `- [ ] !important note` is left untouched. Works with `-`, `*`, `+` bullets and both `[ ]` / `[x]` states. Requires `pymdownx.tasklist` to be enabled alongside this extension.
+
+## Reusing the parser
+
+`badges_in`, `priority_of`, and `rank_of` are exposed for tools that aggregate or filter task items (for example a todo dashboard). Each takes an optional `Mapping[str, Badge]` argument, defaulting to the whole catalogue; pass the result of `resolve_badges` or `catalogue_for` to match your own config instead.
+
+```python
+from markdown_badges import badges_in, priority_of, rank_of
+
+badges_in("!blocker vendor waiting !wip")   # -> [Badge(name="blocker", ...), Badge(name="wip", ...)]
+priority_of("ping !high vendor")            # -> "high"
+priority_of("weekly backup")                # -> None (no priority badge)
+rank_of("blocker")                          # -> 5 (severity index among priority badges)
+rank_of("wip")                              # -> -1 (not a priority badge)
+```
+
+`badges_in` returns every badge found in the text, of any type, in document order. `priority_of` returns the name of the highest-ranked `priority` badge found, or `None`; `status` and `branding` badges are ignored. `rank_of` gives a badge's severity index among the priority badges, or `-1` if it has none.
+
+> [!NOTE]
+> These are plain-text scans, not a Markdown parse. Unlike the rendered badge, a keyword inside a code span or escaped as `\!high` still counts.
+
+## Install & enable
+
+```bash
+uv add markdown-badges
+```
+
+(or `pip install markdown-badges`)
+
+Zensical (`zensical.toml`):
+
+```toml
+[project.markdown_extensions.markdown_badges]
+```
+
+Plain Python-Markdown:
+
+```python
+markdown.markdown(text, extensions=["markdown_badges"])
+```
+
+Add `pymdownx.tasklist` to `extensions` too if you enable the `shorthand` option. The badge renders as `<span class="badge badge--<name>" style="...">...</span>`. The `badge` classes are kept for optional site-side overriding, but no CSS is needed by default.
+
+## Migrating from 0.2.0
+
+The package was renamed from `markdown-priority-badges` to `markdown-badges`, and the config and API changed along with it: see **[MIGRATING.md](https://github.com/antoinekh/markdown-priority-badges/blob/master/MIGRATING.md)**.

markdown_badges-1.0.0/docs/badges.md

@@ -0,0 +1,62 @@
+# Badge catalogue
+
+Every badge below ships with the package and is active out of the box. Nothing here needs config. Use `catalogue` to narrow the set, and `badges` to recolour an entry or add your own.
+
+Generated from `CATALOGUE` in `src/markdown_badges/catalogue.py` by `scripts/gen_badges.py`. Edit the catalogue, not this file.
+
+![Every badge in the catalogue, rendered](img/catalogue.png)
+
+> [!NOTE]
+> Only `priority` badges carry a severity rank. `priority_of` and `rank_of` ignore `status` and `branding` badges entirely; use `badges_in` to get every badge on a line whatever its type.
+
+## Priority
+
+| Keyword | Value | Text | Notes |
+| --- | --- | --- | --- |
+| `!trivial` | `#78909c` | `#000` | Nice to have. |
+| `!low` | `#2e7d32` | `#fff` | Green. |
+| `!medium` | `#f9a825` | `#000` | Amber. |
+| `!high` | `#ef6c00` | `#000` | Orange. |
+| `!critical` | `#d32f2f` | `#fff` | Red. |
+| `!blocker` | `#7b1fa2` | `#fff` | Work that cannot start. |
+
+## Status
+
+| Keyword | Value | Text | Notes |
+| --- | --- | --- | --- |
+| `!todo` | `#1565c0` | `#fff` | Not started. |
+| `!wip` | `#0277bd` | `#fff` | In progress. |
+| `!review` | `#6a1b9a` | `#fff` | Waiting on a reviewer. |
+| `!blocked` | `#b71c1c` | `#fff` | Waiting on someone else. |
+| `!approved` | `#2e7d32` | `#fff` | Signed off, not yet shipped. |
+| `!done` | `#37474f` | `#fff` | Finished. |
+| `!onhold` | `#8d6e63` | `#fff` | Paused on purpose. |
+| `!experimental` | `#00838f` | `#000` | Not stable yet. |
+| `!deprecated` | `#5d4037` | `#fff` | On the way out. |
+
+## Branding
+
+| Keyword | Value | Text | Notes |
+| --- | --- | --- | --- |
+| `!gitlab` | `#7759c2 plus icon CSS` | `#fff` | GitLab purple. |
+| `!github` | `#181717 plus icon CSS` | `#fff` | GitHub near-black. |
+| `!claude` | `#d97757 plus icon CSS` | `#000` | Claude coral, dark mark. |
+| `!docker` | `#1d63ed plus icon CSS` | `#fff` | Docker blue, white whale. |
+| `!aws` | `#232f3e` | `#fff` | AWS squid ink. No mark. |
+
+## Narrowing the catalogue
+
+```toml
+[project.markdown_extensions.markdown_badges]
+catalogue = ["priority", "status"]   # drop the branding badges
+```
+
+## Adding your own
+
+```toml
+[project.markdown_extensions.markdown_badges.badges.priority]
+showstopper = "#000000"   # a new priority, ranked above every catalogue one
+critical = "#8e0000"      # an existing name: recolours it, keeping its rank
+```
+
+For a logo badge, add the mark as a single-path SVG to `ICONS` in `src/markdown_badges/catalogue.py` and build the value with `_icon_value`. Pick the base colour and the icon fill together: the badge text colour comes from the base, so a white mark needs a base that resolves to white text.

markdown_badges-1.0.0/pyproject.toml

@@ -0,0 +1,71 @@
+[project]
+name = "markdown-badges"
+version = "1.0.0"
+description = "Python-Markdown extension rendering inline !name badges, with a catalogue of priority, status and branding badges"
+readme = "README.md"
+license = "MIT"
+authors = [{ name = "Antoine Keranflec'h" }]
+requires-python = ">=3.10"
+dependencies = ["markdown>=3.5"]
+keywords = ["markdown", "mkdocs", "zensical", "badge", "badges", "priority", "status", "branding", "catalogue", "tasklist", "documentation"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Framework :: MkDocs",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Documentation",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Text Processing :: Markup :: Markdown",
+    "Typing :: Typed",
+]
+
+[project.urls]
+Homepage = "https://github.com/antoinekh/markdown-priority-badges"
+Repository = "https://github.com/antoinekh/markdown-priority-badges"
+Issues = "https://github.com/antoinekh/markdown-priority-badges/issues"
+Documentation = "https://github.com/antoinekh/markdown-priority-badges/blob/master/docs/badges.md"
+Changelog = "https://github.com/antoinekh/markdown-priority-badges/blob/master/CHANGELOG.md"
+
+[dependency-groups]
+dev = ["pytest>=8.0", "pymdown-extensions>=10.0", "ruff>=0.8", "mypy>=1.11", "types-Markdown"]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/markdown_badges"]
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "src/**",
+    "tests/**",
+    "README.md",
+    "LICENSE",
+    "CHANGELOG.md",
+    "MIGRATING.md",
+    "pyproject.toml",
+    "docs/img/*.png",
+    "docs/badges.md",
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[tool.ruff]
+line-length = 100
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B"]
+
+[tool.mypy]
+# The package ships py.typed, so the shipped code is checked strictly.
+files = ["src"]
+python_version = "3.10"
+strict = true