eric6/Documentation/Source/eric6.UI.Previewers.MarkdownExtensions.html

<!DOCTYPE html>
<html><head>
<title>eric6.UI.Previewers.MarkdownExtensions</title>
<meta charset="UTF-8">
<style>
body {
    background: #EDECE6;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #85774A; }
h2 { color: white; background: #85774A; }
h3 { color: white; background: #9D936E; }
h4 { color: white; background: #9D936E; }
    
a { color: #BA6D36; }

</style>
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric6.UI.Previewers.MarkdownExtensions</h1>

<p>
Module implementing some Markdown extensions.
</p>
<h3>Global Attributes</h3>

<table>
<tr><td>MermaidRegex</td></tr><tr><td>MermaidRegexFullText</td></tr>
</table>
<h3>Classes</h3>

<table>

<tr>
<td><a href="#MermaidExtension">MermaidExtension</a></td>
<td>Class implementing a Markdown Extension for Mermaid.</td>
</tr>
<tr>
<td><a href="#MermaidPreprocessor">MermaidPreprocessor</a></td>
<td>Class implementing a markdown pre-processor for Mermaid.</td>
</tr>
<tr>
<td><a href="#SimplePatternExtension">SimplePatternExtension</a></td>
<td>Class implementing a Markdown extension for ~, ~~, ^, ^^ and ==.</td>
</tr>
</table>
<h3>Functions</h3>

<table>
<tr><td>None</td></tr>
</table>
<hr />
<hr />
<a NAME="MermaidExtension" ID="MermaidExtension"></a>
<h2>MermaidExtension</h2>

<p>
    Class implementing a Markdown Extension for Mermaid.
</p>
<h3>Derived from</h3>
Extension
<h3>Class Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Class Methods</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>

<table>

<tr>
<td><a href="#MermaidExtension.extendMarkdown">extendMarkdown</a></td>
<td>Public method to register the extension.</td>
</tr>
</table>
<h3>Static Methods</h3>

<table>
<tr><td>None</td></tr>
</table>

<a NAME="MermaidExtension.extendMarkdown" ID="MermaidExtension.extendMarkdown"></a>
<h4>MermaidExtension.extendMarkdown</h4>
<b>extendMarkdown</b>(<i>md, md_globals</i>)

<p>
        Public method to register the extension.
</p>
<dl>

<dt><i>md</i></dt>
<dd>
reference to markdown
</dd>
<dt><i>md_globals</i></dt>
<dd>
global config parameters
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="MermaidPreprocessor" ID="MermaidPreprocessor"></a>
<h2>MermaidPreprocessor</h2>

<p>
    Class implementing a markdown pre-processor for Mermaid.
</p>
<h3>Derived from</h3>
Preprocessor
<h3>Class Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Class Methods</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>

<table>

<tr>
<td><a href="#MermaidPreprocessor.run">run</a></td>
<td>Public method to do the pre-processing.</td>
</tr>
</table>
<h3>Static Methods</h3>

<table>
<tr><td>None</td></tr>
</table>

<a NAME="MermaidPreprocessor.run" ID="MermaidPreprocessor.run"></a>
<h4>MermaidPreprocessor.run</h4>
<b>run</b>(<i>lines</i>)

<p>
        Public method to do the pre-processing.
</p>
<dl>

<dt><i>lines</i> (list of str)</dt>
<dd>
text lines to be processed
</dd>
</dl>
<dl>
<dt>Returns:</dt>
<dd>
processed lines
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
list of str
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="SimplePatternExtension" ID="SimplePatternExtension"></a>
<h2>SimplePatternExtension</h2>

<p>
    Class implementing a Markdown extension for ~, ~~, ^, ^^ and ==.
</p>
<p>
    Note: This is a very simple pattern extension that might conflict with
    formulas set for MathJax. Use the 'pymdown-extensions' package in this
    case.
</p>
<h3>Derived from</h3>
Extension
<h3>Class Attributes</h3>

<table>
<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>
</table>
<h3>Class Methods</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>

<table>

<tr>
<td><a href="#SimplePatternExtension.extendMarkdown">extendMarkdown</a></td>
<td>Public method to register the extension.</td>
</tr>
</table>
<h3>Static Methods</h3>

<table>
<tr><td>None</td></tr>
</table>

<a NAME="SimplePatternExtension.extendMarkdown" ID="SimplePatternExtension.extendMarkdown"></a>
<h4>SimplePatternExtension.extendMarkdown</h4>
<b>extendMarkdown</b>(<i>md</i>)

<p>
        Public method to register the extension.
</p>
<dl>

<dt><i>md</i></dt>
<dd>
reference to markdown
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>