/usr/share/doc/python-markdown-doc/docs/extensions/admonition.html is in python-markdown-doc 2.6.9-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 | <!DOCTYPE html>
<html>
<head>
<meta charset=utf-8>
<title>Admonition Extension — Python Markdown</title>
<link rel="stylesheet" href="../default.css" type="text/css">
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../siteindex.html" title="General Index">index</a></li>
<li class="right">
<a href="code_hilite.html" title="CodeHilite Extension"
accesskey="N">next</a> |</li>
<li class="right">
<a href="smart_strong.html" title="Smart Strong Extension"
accesskey="P">previous</a> |</li>
<li><img src="../py.png" alt=""
style="vertical-align: middle; margin-top: -1px"/></li>
<li><a href="../index.html">Python Markdown v2.6.9 documentation</a> »</li>
<li><a href="index.html">Extensions</a> »</li>
<li><a href="admonition.html">Admonition Extension</a> »</li>
</ul>
</div> <!-- .related -->
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1 id="admonition">Admonition<a class="headerlink" href="#admonition" title="Permanent link">¶</a></h1>
<h2 id="summary">Summary<a class="headerlink" href="#summary" title="Permanent link">¶</a></h2>
<p>The Admonition extension adds <a href="http://docutils.sourceforge.net/docs/ref/rst/directives.html#specific-admonitions">rST-style</a> admonitions to Markdown documents.</p>
<p>This extension is included in the standard Markdown library.</p>
<h2 id="syntax">Syntax<a class="headerlink" href="#syntax" title="Permanent link">¶</a></h2>
<p>Admonitions are created using the following syntax:</p>
<pre><code>!!! type "optional explicit title within double quotes"
Any number of other indented markdown elements.
This is the second paragraph.
</code></pre>
<p><code>type</code> will be used as the CSS class name and as default title. It must be a
single word. So, for instance:</p>
<pre><code>!!! note
You should note that the title will be automatically capitalized.
</code></pre>
<p>will render:</p>
<pre><code><div class="admonition note">
<p class="admonition-title">Note</p>
<p>You should note that the title will be automatically capitalized.</p>
</div>
</code></pre>
<p>Optionally, you can use custom titles. For instance:</p>
<pre><code>!!! danger "Don't try this at home"
...
</code></pre>
<p>will render:</p>
<pre><code><div class="admonition danger">
<p class="admonition-title">Don't try this at home</p>
<p>...</p>
</div>
</code></pre>
<p>If you don’t want a title, use a blank string <code>""</code>:</p>
<pre><code>!!! important ""
This is a admonition box without a title.
</code></pre>
<p>results in:</p>
<pre><code><div class="admonition important">
<p>This is a admonition box without a title.</p>
</div>
</code></pre>
<p>rST suggests the following <code>types</code>, but you’re free to use whatever you want:
attention, caution, danger, error, hint, important, note, tip, warning.</p>
<h2 id="styling">Styling<a class="headerlink" href="#styling" title="Permanent link">¶</a></h2>
<p>There is no CSS included as part of this extension. Look up the default
<a href="http://sphinx.pocoo.org/">Sphinx</a> theme if you need inspiration.</p>
</div> <!-- .body -->
</div> <!-- .bodywrapper -->
</div> <!-- .documentwrapper -->
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3>Table Of Contents</h3>
<div class="toc">
<ul>
<li><a href="#admonition">Admonition</a><ul>
<li><a href="#summary">Summary</a></li>
<li><a href="#syntax">Syntax</a></li>
<li><a href="#styling">Styling</a></li>
</ul>
</li>
</ul>
</div>
<h4>Previous topic</h4>
<p class="topless"><a href="smart_strong.html"
title="previous chapter">Smart Strong Extension</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="code_hilite.html"
title="next chapter">CodeHilite Extension</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="https://github.com/Python-Markdown/markdown/issues"
>Report a Bug</a></li>
<li><a href="admonition.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div> <!-- .sphinxsidebarwrapper -->
</div> <!-- .sphinxsidebar -->
<div class="clearer"></div>
</div> <!-- .document -->
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../siteindex.html" title="General Index">index</a></li>
<li class="right">
<a href="code_hilite.html" title="CodeHilite Extension"
accesskey="N">next</a> |</li>
<li class="right">
<a href="smart_strong.html" title="Smart Strong Extension"
accesskey="P">previous</a> |</li>
<li><img src="../py.png" alt=""
style="vertical-align: middle; margin-top: -1px"/></li>
<li><a href="../index.html">Python Markdown v2.6.9 documentation</a> »</li>
<li><a href="index.html">Extensions</a> »</li>
<li><a href="admonition.html">Admonition Extension</a> »</li>
</ul>
</div> <!-- .related -->
<div class="footer">© 2010-2012 Python Markdown Project</div>
</body>
</html>
|