Skip to content

feat: include gh-admonitions by default#345

Merged
PeaWarrior merged 1 commit into
backstage:mainfrom
stephenglass:codex/add-gh-admonitions
May 14, 2026
Merged

feat: include gh-admonitions by default#345
PeaWarrior merged 1 commit into
backstage:mainfrom
stephenglass:codex/add-gh-admonitions

Conversation

@stephenglass
Copy link
Copy Markdown
Contributor

Summary

Adds gh-admonitions as a default bundled MkDocs plugin in mkdocs-techdocs-core.

This enables GitHub alert syntax such as > [!NOTE], > [!TIP], > [!IMPORTANT], > [!WARNING], and > [!CAUTION] to render as MkDocs Material admonitions without requiring TechDocs users to configure the plugin separately.

Changes

  • Added mkdocs-github-admonitions-plugin==0.1.1 as a pinned dependency.
  • Registered the gh-admonitions plugin by default from techdocs-core.
  • Added unit coverage confirming the plugin is injected into the MkDocs plugin config.
  • Updated the README plugin list to document the new bundled plugin.

Testing

  • python -m unittest techdocs_core/test_core.py
  • pip install --editable .
  • mkdocs build --config-file test-fixtures/mkdocs.yml
  • black --check .

@stephenglass stephenglass requested review from a team and awanlin as code owners May 12, 2026 16:26
Copy link
Copy Markdown
Collaborator

@awanlin awanlin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome, thanks @stephenglass 🚀

Copy link
Copy Markdown
Contributor

@PeaWarrior PeaWarrior left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome. Thanks for your contribution @stephenglass!

@PeaWarrior PeaWarrior merged commit 0fbb148 into backstage:main May 14, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants