From 85e74fb710e64a35b3ed458bdec6cfed7827c3b1 Mon Sep 17 00:00:00 2001
From: Tiago Serafim <tserafim@gmail.com>
Date: Wed, 19 Sep 2012 18:43:21 -0300
Subject: First version of the docs.

---
 docs/extensions/admonition.txt | 75 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 75 insertions(+)
 create mode 100644 docs/extensions/admonition.txt

(limited to 'docs/extensions/admonition.txt')

diff --git a/docs/extensions/admonition.txt b/docs/extensions/admonition.txt
new file mode 100644
index 0000000..48b70c8
--- /dev/null
+++ b/docs/extensions/admonition.txt
@@ -0,0 +1,75 @@
+title:      Admonition
+prev_title: Smart Strong Extension
+prev_url:   smart_strong.html
+next_title: CodeHilite Extension
+next_url:   code_hilite.html
+
+Admonition
+==========
+
+Summary
+-------
+
+This 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:
+
+    !!! [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 classname and as default title. It must be a
+single word. So, for instance:
+
+    !!! note
+        You should note that the title will be automatically capitalized.
+
+will render:
+
+    <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:
+
+    !!! danger "Don't try this at home"
+        ...
+
+will render:
+
+    <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 `""`:
+
+    !!! important ""
+        This is a admonition box without a title.
+
+results in:
+
+    <div class="admonition important">
+    <p>This is a admonition box without a title.</p>
+    </div>
+
+
+rST suggests the following `types`, but you're free to use whatever you want:
+    attention, caution, danger, error, hint, important, note, tip, warning.
+
+Styling
+-------
+
+There is no CSS included as part of this extension. Look up the default
+[Sphinx][sphinx] theme if you need inspiration.
+
+[sphinx]: http://sphinx.pocoo.org/
\ No newline at end of file
-- 
cgit v1.2.3


From f78dcbedf94baa17392dafd5bb08c47d2a57ba74 Mon Sep 17 00:00:00 2001
From: Tiago Serafim <tserafim@gmail.com>
Date: Sat, 9 Feb 2013 17:45:03 -0200
Subject: Better synthax description in the docs.

---
 docs/extensions/admonition.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'docs/extensions/admonition.txt')

diff --git a/docs/extensions/admonition.txt b/docs/extensions/admonition.txt
index 48b70c8..21a16f4 100644
--- a/docs/extensions/admonition.txt
+++ b/docs/extensions/admonition.txt
@@ -21,7 +21,7 @@ Syntax
 
 Admonitions are created using the following syntax:
 
-    !!! [type] [optional explicit title within double quotes]
+    !!! type "optional explicit title within double quotes"
         Any number of other indented markdown elements.
 
         This is the second paragraph.
-- 
cgit v1.2.3