Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.UI.Previewers.MarkdownExtensions.html
src/eric7/Documentation/Source/eric7.UI.Previewers.MarkdownExtensions.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10070
- 9f5758c0fec1
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.UI.Previewers.MarkdownExtensions</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.UI.Previewers.MarkdownExtensions</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing some Markdown extensions. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>MermaidRegex</td></tr><tr><td>MermaidRegexFullText</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#MermaidExtension">MermaidExtension</a></td> | |
| 25 <td>Class implementing a Markdown Extension for Mermaid.</td> | |
| 26 </tr> | |
| 27 <tr> | |
| 28 <td><a href="#MermaidPreprocessor">MermaidPreprocessor</a></td> | |
| 29 <td>Class implementing a markdown pre-processor for Mermaid.</td> | |
| 30 </tr> | |
| 31 <tr> | |
| 32 <td><a href="#SimplePatternExtension">SimplePatternExtension</a></td> | |
| 33 <td>Class implementing a Markdown extension for ~, ~~, ^, ^^ and ==.</td> | |
| 34 </tr> | |
| 35 </table> | |
| 36 <h3>Functions</h3> | |
| 37 | |
| 38 <table> | |
| 39 <tr><td>None</td></tr> | |
| 40 </table> | |
| 41 <hr /> | |
| 42 <hr /> | |
| 43 <a NAME="MermaidExtension" ID="MermaidExtension"></a> | |
| 44 <h2>MermaidExtension</h2> | |
| 45 | |
| 46 <p> | |
| 47 Class implementing a Markdown Extension for Mermaid. | |
| 48 </p> | |
| 49 <h3>Derived from</h3> | |
| 50 Extension | |
| 51 <h3>Class Attributes</h3> | |
| 52 | |
| 53 <table> | |
| 54 <tr><td>None</td></tr> | |
| 55 </table> | |
| 56 <h3>Class Methods</h3> | |
| 57 | |
| 58 <table> | |
| 59 <tr><td>None</td></tr> | |
| 60 </table> | |
| 61 <h3>Methods</h3> | |
| 62 | |
| 63 <table> | |
| 64 | |
| 65 <tr> | |
| 66 <td><a href="#MermaidExtension.extendMarkdown">extendMarkdown</a></td> | |
| 67 <td>Public method to register the extension.</td> | |
| 68 </tr> | |
| 69 </table> | |
| 70 <h3>Static Methods</h3> | |
| 71 | |
| 72 <table> | |
| 73 <tr><td>None</td></tr> | |
| 74 </table> | |
| 75 | |
| 76 <a NAME="MermaidExtension.extendMarkdown" ID="MermaidExtension.extendMarkdown"></a> | |
| 77 <h4>MermaidExtension.extendMarkdown</h4> | |
| 78 <b>extendMarkdown</b>(<i>md, md_globals</i>) | |
| 79 | |
| 80 <p> | |
| 81 Public method to register the extension. | |
| 82 </p> | |
| 83 <dl> | |
| 84 | |
| 85 <dt><i>md</i></dt> | |
| 86 <dd> | |
| 87 reference to markdown | |
| 88 </dd> | |
| 89 <dt><i>md_globals</i></dt> | |
| 90 <dd> | |
| 91 global config parameters | |
| 92 </dd> | |
| 93 </dl> | |
| 94 <div align="right"><a href="#top">Up</a></div> | |
| 95 <hr /> | |
| 96 <hr /> | |
| 97 <a NAME="MermaidPreprocessor" ID="MermaidPreprocessor"></a> | |
| 98 <h2>MermaidPreprocessor</h2> | |
| 99 | |
| 100 <p> | |
| 101 Class implementing a markdown pre-processor for Mermaid. | |
| 102 </p> | |
| 103 <h3>Derived from</h3> | |
| 104 Preprocessor | |
| 105 <h3>Class Attributes</h3> | |
| 106 | |
| 107 <table> | |
| 108 <tr><td>None</td></tr> | |
| 109 </table> | |
| 110 <h3>Class Methods</h3> | |
| 111 | |
| 112 <table> | |
| 113 <tr><td>None</td></tr> | |
| 114 </table> | |
| 115 <h3>Methods</h3> | |
| 116 | |
| 117 <table> | |
| 118 | |
| 119 <tr> | |
| 120 <td><a href="#MermaidPreprocessor.run">run</a></td> | |
| 121 <td>Public method to do the pre-processing.</td> | |
| 122 </tr> | |
| 123 </table> | |
| 124 <h3>Static Methods</h3> | |
| 125 | |
| 126 <table> | |
| 127 <tr><td>None</td></tr> | |
| 128 </table> | |
| 129 | |
| 130 <a NAME="MermaidPreprocessor.run" ID="MermaidPreprocessor.run"></a> | |
| 131 <h4>MermaidPreprocessor.run</h4> | |
| 132 <b>run</b>(<i>lines</i>) | |
| 133 | |
| 134 <p> | |
| 135 Public method to do the pre-processing. | |
| 136 </p> | |
| 137 <dl> | |
| 138 | |
| 139 <dt><i>lines</i> (list of str)</dt> | |
| 140 <dd> | |
| 141 text lines to be processed | |
| 142 </dd> | |
| 143 </dl> | |
| 144 <dl> | |
| 145 <dt>Return:</dt> | |
| 146 <dd> | |
| 147 processed lines | |
| 148 </dd> | |
| 149 </dl> | |
| 150 <dl> | |
| 151 <dt>Return Type:</dt> | |
| 152 <dd> | |
| 153 list of str | |
| 154 </dd> | |
| 155 </dl> | |
| 156 <div align="right"><a href="#top">Up</a></div> | |
| 157 <hr /> | |
| 158 <hr /> | |
| 159 <a NAME="SimplePatternExtension" ID="SimplePatternExtension"></a> | |
| 160 <h2>SimplePatternExtension</h2> | |
| 161 | |
| 162 <p> | |
| 163 Class implementing a Markdown extension for ~, ~~, ^, ^^ and ==. | |
| 164 </p> | |
| 165 <p> | |
| 166 Note: This is a very simple pattern extension that might conflict with | |
| 167 formulas set for MathJax. Use the 'pymdown-extensions' package in this | |
| 168 case. | |
| 169 </p> | |
| 170 <h3>Derived from</h3> | |
| 171 Extension | |
| 172 <h3>Class Attributes</h3> | |
| 173 | |
| 174 <table> | |
| 175 <tr><td>DEL_RE</td></tr><tr><td>INS_RE</td></tr><tr><td>MARK_RE</td></tr><tr><td>SUB_RE</td></tr><tr><td>SUP_RE</td></tr> | |
| 176 </table> | |
| 177 <h3>Class Methods</h3> | |
| 178 | |
| 179 <table> | |
| 180 <tr><td>None</td></tr> | |
| 181 </table> | |
| 182 <h3>Methods</h3> | |
| 183 | |
| 184 <table> | |
| 185 | |
| 186 <tr> | |
| 187 <td><a href="#SimplePatternExtension.extendMarkdown">extendMarkdown</a></td> | |
| 188 <td>Public method to register the extension.</td> | |
| 189 </tr> | |
| 190 </table> | |
| 191 <h3>Static Methods</h3> | |
| 192 | |
| 193 <table> | |
| 194 <tr><td>None</td></tr> | |
| 195 </table> | |
| 196 | |
| 197 <a NAME="SimplePatternExtension.extendMarkdown" ID="SimplePatternExtension.extendMarkdown"></a> | |
| 198 <h4>SimplePatternExtension.extendMarkdown</h4> | |
| 199 <b>extendMarkdown</b>(<i>md</i>) | |
| 200 | |
| 201 <p> | |
| 202 Public method to register the extension. | |
| 203 </p> | |
| 204 <dl> | |
| 205 | |
| 206 <dt><i>md</i></dt> | |
| 207 <dd> | |
| 208 reference to markdown | |
| 209 </dd> | |
| 210 </dl> | |
| 211 <div align="right"><a href="#top">Up</a></div> | |
| 212 <hr /> | |
| 213 </body></html> |
