Update documentation

Python-Markdown · Jan 10, 2024 · 863acff · 863acff
1 parent 1876f89
commit 863acff
Show file tree

Hide file tree

Showing 77 changed files with 6,578 additions and 2,440 deletions.
diff --git a/404.html b/404.html
@@ -11,7 +11,7 @@
         <link rel="search" title="Search" href="/search.html" />
 
 
-        <title>Python-Markdown 3.5.1 documentation</title>
+        <title>Python-Markdown 3.5.2 documentation</title>
         <link rel="stylesheet" href="/static/nature.css" type="text/css" />
         <link rel="stylesheet" href="/static/pygments.css" type="text/css" />
         <link rel="stylesheet" href="/assets/_mkdocstrings.css" type="text/css" />
@@ -36,7 +36,7 @@ <h3>Navigation</h3>
             <li><img src="/py.png"
             alt="icon" style="vertical-align: middle; margin-top: -1px"/></li>
             <li class="nav-item nav-item-0">
-                <a href="/.">Python-Markdown 3.5.1 documentation</a> &#187;
+                <a href="/.">Python-Markdown 3.5.2 documentation</a> &#187;
             </li>
         </ul>
     </div>
@@ -67,6 +67,14 @@ <h3>This Page</h3>
                     <li><a href="https://github.com/Python-Markdown/markdown/issues">Report a Bug</a></li>
                 </ul>
             </div>
+            <div id="searchbox" style="display: none" role="search">
+                <h3>Quick search</h3>
+                <form class="search" action="/search.html" method="get">
+                    <div><input type="text" name="q" placeholder="Search docs" /></div>
+                    <div><input type="submit" value="Go" /></div>
+                </form>
+            </div>
+            <script type="text/javascript">$('#searchbox').show(0);</script>
 
         </div>
     </div>
@@ -87,18 +95,19 @@ <h3>Navigation</h3>
             <li><img src="/py.png"
             alt="icon" style="vertical-align: middle; margin-top: -1px"/></li>
             <li class="nav-item nav-item-0">
-                <a href="/.">Python-Markdown 3.5.1 documentation</a> &#187;
+                <a href="/.">Python-Markdown 3.5.2 documentation</a> &#187;
             </li>
         </ul>
     </div>
         <div class="footer" role="contentinfo">Copyright &copy; 2010-2023, The Python-Markdown Project.
         Created using <a href="https://www.mkdocs.org/">MkDocs</a> 1.5.3.
         </div>
         <script>var base_url = '/';</script>
+        <script src="/search/main.js"></script>
 
         <!--
         MkDocs version      : 1.5.3
-        Docs Build Date UTC : 2023-11-06 03:08:46.342517+00:00
+        Docs Build Date UTC : 2024-01-10 15:19:15.681217+00:00
         -->
     </body>
 </html>
diff --git a/assets/_mkdocstrings.css b/assets/_mkdocstrings.css
@@ -26,39 +26,84 @@
   float: right;
 }
 
-/* Keep headings consistent. */
-h1.doc-heading,
-h2.doc-heading,
-h3.doc-heading,
-h4.doc-heading,
-h5.doc-heading,
-h6.doc-heading {
-  font-weight: 400;
-  line-height: 1.5;
-  color: inherit;
-  text-transform: none;
+/* Symbols in Navigation and ToC. */
+:root,
+[data-md-color-scheme="default"] {
+  --doc-symbol-attribute-fg-color: #953800;
+  --doc-symbol-function-fg-color: #8250df;
+  --doc-symbol-method-fg-color: #8250df;
+  --doc-symbol-class-fg-color: #0550ae;
+  --doc-symbol-module-fg-color: #5cad0f;
+
+  --doc-symbol-attribute-bg-color: #9538001a;
+  --doc-symbol-function-bg-color: #8250df1a;
+  --doc-symbol-method-bg-color: #8250df1a;
+  --doc-symbol-class-bg-color: #0550ae1a;
+  --doc-symbol-module-bg-color: #5cad0f1a;
+}
+
+[data-md-color-scheme="slate"] {
+  --doc-symbol-attribute-fg-color: #ffa657;
+  --doc-symbol-function-fg-color: #d2a8ff;
+  --doc-symbol-method-fg-color: #d2a8ff;
+  --doc-symbol-class-fg-color: #79c0ff;
+  --doc-symbol-module-fg-color: #baff79;
+
+  --doc-symbol-attribute-bg-color: #ffa6571a;
+  --doc-symbol-function-bg-color: #d2a8ff1a;
+  --doc-symbol-method-bg-color: #d2a8ff1a;
+  --doc-symbol-class-bg-color: #79c0ff1a;
+  --doc-symbol-module-bg-color: #baff791a;
+}
+
+code.doc-symbol {
+  border-radius: .1rem;
+  font-size: .85em;
+  padding: 0 .3em;
+  font-weight: bold;
+}
+
+code.doc-symbol-attribute {
+  color: var(--doc-symbol-attribute-fg-color);
+  background-color: var(--doc-symbol-attribute-bg-color);
+}
+
+code.doc-symbol-attribute::after {
+  content: "attr";
+}
+
+code.doc-symbol-function {
+  color: var(--doc-symbol-function-fg-color);
+  background-color: var(--doc-symbol-function-bg-color);
+}
+
+code.doc-symbol-function::after {
+  content: "func";
 }
 
-h1.doc-heading {
-  font-size: 1.6rem;
+code.doc-symbol-method {
+  color: var(--doc-symbol-method-fg-color);
+  background-color: var(--doc-symbol-method-bg-color);
 }
 
-h2.doc-heading {
-  font-size: 1.2rem;
+code.doc-symbol-method::after {
+  content: "meth";
 }
 
-h3.doc-heading {
-  font-size: 1.15rem;
+code.doc-symbol-class {
+  color: var(--doc-symbol-class-fg-color);
+  background-color: var(--doc-symbol-class-bg-color);
 }
 
-h4.doc-heading {
-  font-size: 1.10rem;
+code.doc-symbol-class::after {
+  content: "class";
 }
 
-h5.doc-heading {
-  font-size: 1.05rem;
+code.doc-symbol-module {
+  color: var(--doc-symbol-module-fg-color);
+  background-color: var(--doc-symbol-module-bg-color);
 }
 
-h6.doc-heading {
-  font-size: 1rem;
+code.doc-symbol-module::after {
+  content: "mod";
 }
diff --git a/authors/index.html b/authors/index.html
@@ -11,7 +11,7 @@
         <link rel="search" title="Search" href="../search.html" />
 
         <link rel="prev" title="Changelog" href="../changelog/" />
-        <title>Authors &#8212; Python-Markdown 3.5.1 documentation</title>
+        <title>Authors &#8212; Python-Markdown 3.5.2 documentation</title>
         <link rel="stylesheet" href="../static/nature.css" type="text/css" />
         <link rel="stylesheet" href="../static/pygments.css" type="text/css" />
         <link rel="stylesheet" href="../assets/_mkdocstrings.css" type="text/css" />
@@ -38,7 +38,7 @@ <h3>Navigation</h3>
             <li><img src="../py.png"
             alt="icon" style="vertical-align: middle; margin-top: -1px"/></li>
             <li class="nav-item nav-item-0">
-                <a href="..">Python-Markdown 3.5.1 documentation</a> &#187;
+                <a href="..">Python-Markdown 3.5.2 documentation</a> &#187;
             </li>
 
 
@@ -160,6 +160,14 @@ <h3>This Page</h3>
                     <li><a href="https://github.com/Python-Markdown/markdown/edit/master/docs/authors.md">Edit on GitHub</a></li>
                 </ul>
             </div>
+            <div id="searchbox" style="display: none" role="search">
+                <h3>Quick search</h3>
+                <form class="search" action="../search.html" method="get">
+                    <div><input type="text" name="q" placeholder="Search docs" /></div>
+                    <div><input type="submit" value="Go" /></div>
+                </form>
+            </div>
+            <script type="text/javascript">$('#searchbox').show(0);</script>
 
         </div>
     </div>
@@ -182,7 +190,7 @@ <h3>Navigation</h3>
             <li><img src="../py.png"
             alt="icon" style="vertical-align: middle; margin-top: -1px"/></li>
             <li class="nav-item nav-item-0">
-                <a href="..">Python-Markdown 3.5.1 documentation</a> &#187;
+                <a href="..">Python-Markdown 3.5.2 documentation</a> &#187;
             </li>
 
 
@@ -205,10 +213,11 @@ <h3>Navigation</h3>
         Created using <a href="https://www.mkdocs.org/">MkDocs</a> 1.5.3.
         </div>
         <script>var base_url = '..';</script>
+        <script src="../search/main.js"></script>
 
         <!--
         MkDocs version      : 1.5.3
-        Docs Build Date UTC : 2023-11-06 03:08:46.344541+00:00
+        Docs Build Date UTC : 2024-01-10 15:19:15.692764+00:00
         -->
     </body>
 </html>
diff --git a/change_log/index.html b/change_log/index.html
@@ -11,7 +11,7 @@
         <link rel="search" title="Search" href="../search.html" />
 
 
-        <title>Change Log &#8212; Python-Markdown 3.5.1 documentation</title>
+        <title>Change Log &#8212; Python-Markdown 3.5.2 documentation</title>
         <link rel="stylesheet" href="../static/nature.css" type="text/css" />
         <link rel="stylesheet" href="../static/pygments.css" type="text/css" />
         <link rel="stylesheet" href="../assets/_mkdocstrings.css" type="text/css" />
@@ -36,7 +36,7 @@ <h3>Navigation</h3>
             <li><img src="../py.png"
             alt="icon" style="vertical-align: middle; margin-top: -1px"/></li>
             <li class="nav-item nav-item-0">
-                <a href="..">Python-Markdown 3.5.1 documentation</a> &#187;
+                <a href="..">Python-Markdown 3.5.2 documentation</a> &#187;
             </li>
 
 
@@ -232,6 +232,14 @@ <h3>This Page</h3>
                     <li><a href="https://github.com/Python-Markdown/markdown/edit/master/docs/change_log/index.md">Edit on GitHub</a></li>
                 </ul>
             </div>
+            <div id="searchbox" style="display: none" role="search">
+                <h3>Quick search</h3>
+                <form class="search" action="../search.html" method="get">
+                    <div><input type="text" name="q" placeholder="Search docs" /></div>
+                    <div><input type="submit" value="Go" /></div>
+                </form>
+            </div>
+            <script type="text/javascript">$('#searchbox').show(0);</script>
 
         </div>
     </div>
@@ -252,7 +260,7 @@ <h3>Navigation</h3>
             <li><img src="../py.png"
             alt="icon" style="vertical-align: middle; margin-top: -1px"/></li>
             <li class="nav-item nav-item-0">
-                <a href="..">Python-Markdown 3.5.1 documentation</a> &#187;
+                <a href="..">Python-Markdown 3.5.2 documentation</a> &#187;
             </li>
 
 
@@ -272,10 +280,11 @@ <h3>Navigation</h3>
         Created using <a href="https://www.mkdocs.org/">MkDocs</a> 1.5.3.
         </div>
         <script>var base_url = '..';</script>
+        <script src="../search/main.js"></script>
 
         <!--
         MkDocs version      : 1.5.3
-        Docs Build Date UTC : 2023-11-06 03:08:46.349797+00:00
+        Docs Build Date UTC : 2024-01-10 15:19:15.720238+00:00
         -->
     </body>
 </html>
diff --git a/change_log/release-2.0/index.html b/change_log/release-2.0/index.html
@@ -11,7 +11,7 @@
         <link rel="search" title="Search" href="../../search.html" />
 
 
-        <title>Release Notes for v2.0 &#8212; Python-Markdown 3.5.1 documentation</title>
+        <title>Release Notes for v2.0 &#8212; Python-Markdown 3.5.2 documentation</title>
         <link rel="stylesheet" href="../../static/nature.css" type="text/css" />
         <link rel="stylesheet" href="../../static/pygments.css" type="text/css" />
         <link rel="stylesheet" href="../../assets/_mkdocstrings.css" type="text/css" />
@@ -36,7 +36,7 @@ <h3>Navigation</h3>
             <li><img src="../../py.png"
             alt="icon" style="vertical-align: middle; margin-top: -1px"/></li>
             <li class="nav-item nav-item-0">
-                <a href="../..">Python-Markdown 3.5.1 documentation</a> &#187;
+                <a href="../..">Python-Markdown 3.5.2 documentation</a> &#187;
             </li>
 
 
@@ -140,6 +140,14 @@ <h3>This Page</h3>
                     <li><a href="https://github.com/Python-Markdown/markdown/edit/master/docs/change_log/release-2.0.md">Edit on GitHub</a></li>
                 </ul>
             </div>
+            <div id="searchbox" style="display: none" role="search">
+                <h3>Quick search</h3>
+                <form class="search" action="../../search.html" method="get">
+                    <div><input type="text" name="q" placeholder="Search docs" /></div>
+                    <div><input type="submit" value="Go" /></div>
+                </form>
+            </div>
+            <script type="text/javascript">$('#searchbox').show(0);</script>
 
         </div>
     </div>
@@ -160,7 +168,7 @@ <h3>Navigation</h3>
             <li><img src="../../py.png"
             alt="icon" style="vertical-align: middle; margin-top: -1px"/></li>
             <li class="nav-item nav-item-0">
-                <a href="../..">Python-Markdown 3.5.1 documentation</a> &#187;
+                <a href="../..">Python-Markdown 3.5.2 documentation</a> &#187;
             </li>
 
 
@@ -180,10 +188,11 @@ <h3>Navigation</h3>
         Created using <a href="https://www.mkdocs.org/">MkDocs</a> 1.5.3.
         </div>
         <script>var base_url = '../..';</script>
+        <script src="../../search/main.js"></script>
 
         <!--
         MkDocs version      : 1.5.3
-        Docs Build Date UTC : 2023-11-06 03:08:46.350383+00:00
+        Docs Build Date UTC : 2024-01-10 15:19:15.722569+00:00
         -->
     </body>
 </html>
diff --git a/change_log/release-2.1/index.html b/change_log/release-2.1/index.html
@@ -11,7 +11,7 @@
         <link rel="search" title="Search" href="../../search.html" />
 
 
-        <title>Release Notes for v2.1 &#8212; Python-Markdown 3.5.1 documentation</title>
+        <title>Release Notes for v2.1 &#8212; Python-Markdown 3.5.2 documentation</title>
         <link rel="stylesheet" href="../../static/nature.css" type="text/css" />
         <link rel="stylesheet" href="../../static/pygments.css" type="text/css" />
         <link rel="stylesheet" href="../../assets/_mkdocstrings.css" type="text/css" />
@@ -36,7 +36,7 @@ <h3>Navigation</h3>
             <li><img src="../../py.png"
             alt="icon" style="vertical-align: middle; margin-top: -1px"/></li>
             <li class="nav-item nav-item-0">
-                <a href="../..">Python-Markdown 3.5.1 documentation</a> &#187;
+                <a href="../..">Python-Markdown 3.5.2 documentation</a> &#187;
             </li>
 
 
@@ -195,6 +195,14 @@ <h3>This Page</h3>
                     <li><a href="https://github.com/Python-Markdown/markdown/edit/master/docs/change_log/release-2.1.md">Edit on GitHub</a></li>
                 </ul>
             </div>
+            <div id="searchbox" style="display: none" role="search">
+                <h3>Quick search</h3>
+                <form class="search" action="../../search.html" method="get">
+                    <div><input type="text" name="q" placeholder="Search docs" /></div>
+                    <div><input type="submit" value="Go" /></div>
+                </form>
+            </div>
+            <script type="text/javascript">$('#searchbox').show(0);</script>
 
         </div>
     </div>
@@ -215,7 +223,7 @@ <h3>Navigation</h3>
             <li><img src="../../py.png"
             alt="icon" style="vertical-align: middle; margin-top: -1px"/></li>
             <li class="nav-item nav-item-0">
-                <a href="../..">Python-Markdown 3.5.1 documentation</a> &#187;
+                <a href="../..">Python-Markdown 3.5.2 documentation</a> &#187;
             </li>
 
 
@@ -235,10 +243,11 @@ <h3>Navigation</h3>
         Created using <a href="https://www.mkdocs.org/">MkDocs</a> 1.5.3.
         </div>
         <script>var base_url = '../..';</script>
+        <script src="../../search/main.js"></script>
 
         <!--
         MkDocs version      : 1.5.3
-        Docs Build Date UTC : 2023-11-06 03:08:46.350985+00:00
+        Docs Build Date UTC : 2024-01-10 15:19:15.723786+00:00
         -->
     </body>
 </html>