aboutsummaryrefslogtreecommitdiffstats
path: root/markdown/extensions/admonition.py
diff options
context:
space:
mode:
authorWaylan Limberg <waylan.limberg@icloud.com>2014-08-21 11:11:40 -0400
committerWaylan Limberg <waylan.limberg@icloud.com>2014-08-21 11:11:40 -0400
commit31ea829c686f6ed4cca5258967c0a30077f933f6 (patch)
treefbbaeb24ee32efcc3dbe458d1f49161fb8436208 /markdown/extensions/admonition.py
parent96636540ed04d29d6726f253ae014e89ecb0713c (diff)
downloadmarkdown-31ea829c686f6ed4cca5258967c0a30077f933f6.tar.gz
markdown-31ea829c686f6ed4cca5258967c0a30077f933f6.tar.bz2
markdown-31ea829c686f6ed4cca5258967c0a30077f933f6.zip
Standardized all extension header comments to a uniform format.
Diffstat (limited to 'markdown/extensions/admonition.py')
-rw-r--r--markdown/extensions/admonition.py35
1 files changed, 6 insertions, 29 deletions
diff --git a/markdown/extensions/admonition.py b/markdown/extensions/admonition.py
index 7888d5e..189f2c2 100644
--- a/markdown/extensions/admonition.py
+++ b/markdown/extensions/admonition.py
@@ -4,39 +4,16 @@ Admonition extension for Python-Markdown
Adds rST-style admonitions. Inspired by [rST][] feature with the same name.
-The syntax is (followed by an indented block with the contents):
- !!! [type] [optional explicit title]
-
-Where `type` is used as a CSS class name of the div. If not present, `title`
-defaults to the capitalized `type`, so "note" -> "Note".
-
-rST suggests the following `types`, but you're free to use whatever you want:
- attention, caution, danger, error, hint, important, note, tip, warning
-
-
-A simple example:
- !!! note
- This is the first line inside the box.
-
-Outputs:
- <div class="admonition note">
- <p class="admonition-title">Note</p>
- <p>This is the first line inside the box</p>
- </div>
+[rST]: http://docutils.sourceforge.net/docs/ref/rst/directives.html#specific-admonitions
-You can also specify the title and CSS class of the admonition:
- !!! custom "Did you know?"
- Another line here.
+See <https://pythonhosted.org/Markdown/extensions/admonition.html>
+for documentation.
-Outputs:
- <div class="admonition custom">
- <p class="admonition-title">Did you know?</p>
- <p>Another line here.</p>
- </div>
+Original code Copyright [Tiago Serafim](http://www.tiagoserafim.com/).
-[rST]: http://docutils.sourceforge.net/docs/ref/rst/directives.html#specific-admonitions
+All changes Copyright The Python Markdown Project
-By [Tiago Serafim](http://www.tiagoserafim.com/).
+License: [BSD](http://www.opensource.org/licenses/bsd-license.php)
"""