Skip to content

Commit

Permalink
build: copier-auto-update
Browse files Browse the repository at this point in the history
  • Loading branch information
KyleKing committed Dec 15, 2024
1 parent e692acc commit a5c965f
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .copier-answers.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# Answer file maintained by Copier for: https://github.com/KyleKing/mdformat-plugin-template
# DO NOT MODIFY THIS FILE. Edit by re-running copier and changing responses to the questions
# Check into version control.
_commit: 1.1.2
_commit: 1.1.4
_src_path: gh:KyleKing/mdformat-plugin-template
author_email: dev.act.kyle@gmail.com
author_name: Kyle King
Expand Down
25 changes: 25 additions & 0 deletions mdformat_admon/_synced/admon_factories/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Admonition/Callout Factories

This code is useful to format and render admonitions similar to Python Markdown's format

If you are looking to add `mdformat` to your project to format a specific syntax, you will want to use one of the below plugins:

- [`mdformat-admon`](https://github.com/KyleKing/mdformat-admon)
- [`python-markdown` admonitions](https://python-markdown.github.io/extensions/admonition)
- [`mdformat-mkdocs`](https://github.com/KyleKing/mdformat-mkdocs)
- [MKDocs Admonitions](https://squidfunk.github.io/mkdocs-material/reference/admonitions)
- [`mdformat-gfm-alerts`](https://github.com/KyleKing/mdformat-gfm-alerts)
- Primarily supports [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), but indirectly also supports
- [Microsoft "Alerts"](https://learn.microsoft.com/en-us/contribute/content/markdown-reference#alerts-note-tip-important-caution-warning)
- [Mozilla Callouts](https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN#notes_warnings_and_callouts)
- [`mdformat-obsidian`](https://github.com/KyleKing/mdformat-obsidian)
- [Obsidian Callouts](https://help.obsidian.md/How+to/Use+callouts)

However, directive-style admonition formats are not known to be supported by an existing mdformat plugin nor by the utility code in this directory as it exists today:

- [node.js markdown-it-container](https://github.com/markdown-it/markdown-it-container)
- [MyST](https://myst-parser.readthedocs.io/en/latest/syntax/roles-and-directives.html)
- [Sphinx Directives](https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html)
- [reStructuredText](https://docutils.sourceforge.io/docs/ref/rst/directives.html#specific-admonitions)
- [pymdown-extensions](https://facelessuser.github.io/pymdown-extensions/extensions/blocks/plugins/admonition)
- [PyMDown](https://facelessuser.github.io/pymdown-extensions/extensions/blocks/plugins/admonition)

0 comments on commit a5c965f

Please sign in to comment.