feat: include gh-admonitions by default#345
Open
stephenglass wants to merge 1 commit into
Open
Conversation
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
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.
Summary
Adds
gh-admonitionsas a default bundled MkDocs plugin inmkdocs-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
mkdocs-github-admonitions-plugin==0.1.1as a pinned dependency.gh-admonitionsplugin by default fromtechdocs-core.Testing
python -m unittest techdocs_core/test_core.pypip install --editable .mkdocs build --config-file test-fixtures/mkdocs.ymlblack --check .