diff options
Diffstat (limited to 'docs/extensions/admonition.md')
-rw-r--r-- | docs/extensions/admonition.md | 115 |
1 files changed, 115 insertions, 0 deletions
diff --git a/docs/extensions/admonition.md b/docs/extensions/admonition.md new file mode 100644 index 0000000..4f79d48 --- /dev/null +++ b/docs/extensions/admonition.md @@ -0,0 +1,115 @@ +title: Admonition Extension + +Admonition +========== + +Summary +------- + +The Admonition extension adds [rST-style][rST] admonitions to Markdown documents. + +This extension is included in the standard Markdown library. + +[rST]: http://docutils.sourceforge.net/docs/ref/rst/directives.html#specific-admonitions + +Syntax +------ + +Admonitions are created using the following syntax: + +```md +!!! type "optional explicit title within double quotes" + Any number of other indented markdown elements. + + This is the second paragraph. +``` + +`type` will be used as the CSS class name and as default title. It must be a +single word. So, for instance: + +```md +!!! note + You should note that the title will be automatically capitalized. +``` + +will render: + +```html +<div class="admonition note"> +<p class="admonition-title">Note</p> +<p>You should note that the title will be automatically capitalized.</p> +</div> +``` + +Optionally, you can use custom titles. For instance: + +```md +!!! danger "Don't try this at home" + ... +``` + +will render: + +```html +<div class="admonition danger"> +<p class="admonition-title">Don't try this at home</p> +<p>...</p> +</div> +``` + +If you don't want a title, use a blank string `""`: + +```md +!!! important "" + This is an admonition box without a title. +``` + +results in: + +```html +<div class="admonition important"> +<p>This is an admonition box without a title.</p> +</div> +``` + +You can also provide additional CSS class names separated by spaces. The first +class should be the "type." For example: + +```md +!!! danger highlight blink "Don't try this at home" + ... +``` + +will render: + +```html +<div class="admonition danger highlight blink"> +<p class="admonition-title">Don't try this at home</p> +<p>...</p> +</div> +``` + +rST suggests the following "types": `attention`, `caution`, `danger`, `error`, +`hint`, `important`, `note`, `tip`, and `warning`; however, you're free to use +whatever you want. + +Styling +------- + +There is no CSS included as part of this extension. Check out the default +[Sphinx][sphinx] theme for inspiration. + +[sphinx]: https://www.sphinx-doc.org/en/master/ + +## Usage + +See [Extensions](index.md) for general extension usage. Use `admonition` as the +name of the extension. + +This extension does not accept any special configuration options. + +A trivial example: + +```python +markdown.markdown(some_text, extensions=['admonition']) +``` |