3 lines
14 KiB
HTML
3 lines
14 KiB
HTML
<!DOCTYPE html PUBLIC ""
|
||
"">
|
||
<html><head><meta charset="UTF-8" /><title>html-to-md.html-to-md documentation</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Html-to-md</span> <span class="project-version">0.2.0</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Topics</span></h3><ul><li class="depth-1 "><a href="intro.html"><div class="inner"><span>Introduction to html-to-md</span></div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>html-to-md</span></div></div></li><li class="depth-2 branch"><a href="html-to-md.blogger-to-md.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>blogger-to-md</span></div></a></li><li class="depth-2 branch"><a href="html-to-md.core.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>core</span></div></a></li><li class="depth-2 branch current"><a href="html-to-md.html-to-md.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>html-to-md</span></div></a></li><li class="depth-2"><a href="html-to-md.transformer.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>transformer</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="html-to-md.html-to-md.html#var-markdown-a"><div class="inner"><span>markdown-a</span></div></a></li><li class="depth-1"><a href="html-to-md.html-to-md.html#var-markdown-br"><div class="inner"><span>markdown-br</span></div></a></li><li class="depth-1"><a href="html-to-md.html-to-md.html#var-markdown-code"><div class="inner"><span>markdown-code</span></div></a></li><li class="depth-1"><a href="html-to-md.html-to-md.html#var-markdown-default"><div class="inner"><span>markdown-default</span></div></a></li><li class="depth-1"><a href="html-to-md.html-to-md.html#var-markdown-dispatcher"><div class="inner"><span>markdown-dispatcher</span></div></a></li><li class="depth-1"><a href="html-to-md.html-to-md.html#var-markdown-div"><div class="inner"><span>markdown-div</span></div></a></li><li class="depth-1"><a href="html-to-md.html-to-md.html#var-markdown-em"><div class="inner"><span>markdown-em</span></div></a></li><li class="depth-1"><a href="html-to-md.html-to-md.html#var-markdown-h1"><div class="inner"><span>markdown-h1</span></div></a></li><li class="depth-1"><a href="html-to-md.html-to-md.html#var-markdown-h2"><div class="inner"><span>markdown-h2</span></div></a></li><li class="depth-1"><a href="html-to-md.html-to-md.html#var-markdown-h3"><div class="inner"><span>markdown-h3</span></div></a></li><li class="depth-1"><a href="html-to-md.html-to-md.html#var-markdown-h4"><div class="inner"><span>markdown-h4</span></div></a></li><li class="depth-1"><a href="html-to-md.html-to-md.html#var-markdown-h5"><div class="inner"><span>markdown-h5</span></div></a></li><li class="depth-1"><a href="html-to-md.html-to-md.html#var-markdown-h6"><div class="inner"><span>markdown-h6</span></div></a></li><li class="depth-1"><a href="html-to-md.html-to-md.html#var-markdown-header"><div class="inner"><span>markdown-header</span></div></a></li><li class="depth-1"><a href="html-to-md.html-to-md.html#var-markdown-html"><div class="inner"><span>markdown-html</span></div></a></li><li class="depth-1"><a href="html-to-md.html-to-md.html#var-markdown-img"><div class="inner"><span>markdown-img</span></div></a></li><li class="depth-1"><a href="html-to-md.html-to-md.html#var-markdown-ol"><div class="inner"><span>markdown-ol</span></div></a></li><li class="depth-1"><a href="html-to-md.html-to-md.html#var-markdown-omit"><div class="inner"><span>markdown-omit</span></div></a></li><li class="depth-1"><a href="html-to-md.html-to-md.html#var-markdown-pre"><div class="inner"><span>markdown-pre</span></div></a></li><li class="depth-1"><a href="html-to-md.html-to-md.html#var-markdown-strong"><div class="inner"><span>markdown-strong</span></div></a></li><li class="depth-1"><a href="html-to-md.html-to-md.html#var-markdown-ul"><div class="inner"><span>markdown-ul</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">html-to-md.html-to-md</h1><div class="doc"><div class="markdown"><p>Transform general HTML to <a href="https://daringfireball.net/projects/markdown/">Markdown</a>, as faithfully as is reasonably possible.</p></div></div><div class="public anchor" id="var-markdown-a"><h3>markdown-a</h3><div class="usage"><code>(markdown-a e d)</code></div><div class="doc"><div class="markdown"><p>Process the anchor element <code>e</code> into markdown, using dispatcher <code>d</code>.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/html-to-md/blob/master/src/html_to_md/html_to_md.clj#L10">view source</a></div></div><div class="public anchor" id="var-markdown-br"><h3>markdown-br</h3><div class="usage"><code>(markdown-br e d)</code></div><div class="doc"><div class="markdown"><p>Process the line-break element <code>e</code>, so beloved of tag-soupers, into markdown</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/html-to-md/blob/master/src/html_to_md/html_to_md.clj#L20">view source</a></div></div><div class="public anchor" id="var-markdown-code"><h3>markdown-code</h3><div class="usage"><code>(markdown-code e d)</code></div><div class="doc"><div class="markdown"><p>Process the code or samp <code>e</code> into markdown, using dispatcher <code>d</code>.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/html-to-md/blob/master/src/html_to_md/html_to_md.clj#L26">view source</a></div></div><div class="public anchor" id="var-markdown-default"><h3>markdown-default</h3><div class="usage"><code>(markdown-default e d)</code></div><div class="doc"><div class="markdown"><p>Process an element <code>e</code> for which we have no other function into markdown, using dispatcher <code>d</code>.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/html-to-md/blob/master/src/html_to_md/html_to_md.clj#L34">view source</a></div></div><div class="public anchor" id="var-markdown-dispatcher"><h3>markdown-dispatcher</h3><div class="usage"></div><div class="doc"><div class="markdown"><p>A dispatcher for transforming (X)HTML into Markdown.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/html-to-md/blob/master/src/html_to_md/html_to_md.clj#L170">view source</a></div></div><div class="public anchor" id="var-markdown-div"><h3>markdown-div</h3><div class="usage"><code>(markdown-div e d)</code></div><div class="doc"><div class="markdown"><p>Process the division element <code>e</code> into markdown, using dispatcher <code>d</code>.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/html-to-md/blob/master/src/html_to_md/html_to_md.clj#L40">view source</a></div></div><div class="public anchor" id="var-markdown-em"><h3>markdown-em</h3><div class="usage"><code>(markdown-em e d)</code></div><div class="doc"><div class="markdown"><p>Process the emphasis element <code>e</code> into markdown, using dispatcher <code>d</code>.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/html-to-md/blob/master/src/html_to_md/html_to_md.clj#L48">view source</a></div></div><div class="public anchor" id="var-markdown-h1"><h3>markdown-h1</h3><div class="usage"><code>(markdown-h1 e d)</code></div><div class="doc"><div class="markdown"><p>Process the header element <code>e</code> into markdown, with level 1, using dispatcher <code>d</code>.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/html-to-md/blob/master/src/html_to_md/html_to_md.clj#L67">view source</a></div></div><div class="public anchor" id="var-markdown-h2"><h3>markdown-h2</h3><div class="usage"><code>(markdown-h2 e d)</code></div><div class="doc"><div class="markdown"><p>Process the header element <code>e</code> into markdown, with level 2, using dispatcher <code>d</code>.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/html-to-md/blob/master/src/html_to_md/html_to_md.clj#L73">view source</a></div></div><div class="public anchor" id="var-markdown-h3"><h3>markdown-h3</h3><div class="usage"><code>(markdown-h3 e d)</code></div><div class="doc"><div class="markdown"><p>Process the header element <code>e</code> into markdown, with level 3, using dispatcher <code>d</code>.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/html-to-md/blob/master/src/html_to_md/html_to_md.clj#L79">view source</a></div></div><div class="public anchor" id="var-markdown-h4"><h3>markdown-h4</h3><div class="usage"><code>(markdown-h4 e d)</code></div><div class="doc"><div class="markdown"><p>Process the header element <code>e</code> into markdown, with level 4, using dispatcher <code>d</code>.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/html-to-md/blob/master/src/html_to_md/html_to_md.clj#L85">view source</a></div></div><div class="public anchor" id="var-markdown-h5"><h3>markdown-h5</h3><div class="usage"><code>(markdown-h5 e d)</code></div><div class="doc"><div class="markdown"><p>Process the header element <code>e</code> into markdown, with level 5, using dispatcher <code>d</code>.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/html-to-md/blob/master/src/html_to_md/html_to_md.clj#L91">view source</a></div></div><div class="public anchor" id="var-markdown-h6"><h3>markdown-h6</h3><div class="usage"><code>(markdown-h6 e d)</code></div><div class="doc"><div class="markdown"><p>Process the header element <code>e</code> into markdown, with level 6, using dispatcher <code>d</code>.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/html-to-md/blob/master/src/html_to_md/html_to_md.clj#L97">view source</a></div></div><div class="public anchor" id="var-markdown-header"><h3>markdown-header</h3><div class="usage"><code>(markdown-header e d level)</code></div><div class="doc"><div class="markdown"><p>Process the header element <code>e</code> into markdown, with level <code>level</code>, using dispatcher <code>d</code>.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/html-to-md/blob/master/src/html_to_md/html_to_md.clj#L56">view source</a></div></div><div class="public anchor" id="var-markdown-html"><h3>markdown-html</h3><div class="usage"><code>(markdown-html e d)</code></div><div class="doc"><div class="markdown"><p>Process this HTML element <code>e</code> into markdown, using dispatcher <code>d</code>.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/html-to-md/blob/master/src/html_to_md/html_to_md.clj#L103">view source</a></div></div><div class="public anchor" id="var-markdown-img"><h3>markdown-img</h3><div class="usage"><code>(markdown-img e d)</code></div><div class="doc"><div class="markdown"><p>Process this image element <code>e</code> into markdown, using dispatcher <code>d</code>.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/html-to-md/blob/master/src/html_to_md/html_to_md.clj#L108">view source</a></div></div><div class="public anchor" id="var-markdown-ol"><h3>markdown-ol</h3><div class="usage"><code>(markdown-ol e d)</code></div><div class="doc"><div class="markdown"><p>Process this ordered list element <code>e</code> into markdown, using dispatcher <code>d</code>.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/html-to-md/blob/master/src/html_to_md/html_to_md.clj#L113">view source</a></div></div><div class="public anchor" id="var-markdown-omit"><h3>markdown-omit</h3><div class="usage"><code>(markdown-omit e d)</code></div><div class="doc"><div class="markdown"><p>Don’t process the element <code>e</code> into markdown, but return <code>nil</code>.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/html-to-md/blob/master/src/html_to_md/html_to_md.clj#L130">view source</a></div></div><div class="public anchor" id="var-markdown-pre"><h3>markdown-pre</h3><div class="usage"><code>(markdown-pre e d)</code></div><div class="doc"><div class="markdown"><p>Process the preformatted emphasis element <code>e</code> into markdown, using dispatcher <code>d</code>.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/html-to-md/blob/master/src/html_to_md/html_to_md.clj#L135">view source</a></div></div><div class="public anchor" id="var-markdown-strong"><h3>markdown-strong</h3><div class="usage"><code>(markdown-strong e d)</code></div><div class="doc"><div class="markdown"><p>Process the strong emphasis element <code>e</code> into markdown, using dispatcher <code>d</code>.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/html-to-md/blob/master/src/html_to_md/html_to_md.clj#L144">view source</a></div></div><div class="public anchor" id="var-markdown-ul"><h3>markdown-ul</h3><div class="usage"><code>(markdown-ul e d)</code></div><div class="doc"><div class="markdown"><p>Process this unordered list element <code>e</code> into markdown, using dispatcher <code>d</code>.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/html-to-md/blob/master/src/html_to_md/html_to_md.clj#L153">view source</a></div></div></div></body></html> |