html-to-md/docs/index.html
Simon Brooke e066c033be Deliberately added generated documentation to the repo
To see if I can make documentation pages work on github.
2019-05-01 14:02:24 +01:00

3 lines
6.6 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html PUBLIC ""
"">
<html><head><meta charset="UTF-8" /><title>Html-to-md 0.2.0</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 current"><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"><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="namespace-index" id="content"><h1><span class="project-title"><span class="project-name">Html-to-md</span> <span class="project-version">0.2.0</span></span></h1><h5 class="license">Released under the <a href="http://www.eclipse.org/legal/epl-v10.html">Eclipse Public License</a></h5><div class="doc"><p>Convert (Enlivened) HTML to markdown; but, more generally, a framework for [HT|SG|X]ML transformation.</p></div><h2>Installation</h2><p>To install, add the following dependency to your project or build file:</p><pre class="deps">[html-to-md "0.2.0"]</pre><h2>Topics</h2><ul class="topics"><li><a href="intro.html">Introduction to html-to-md</a></li></ul><h2>Namespaces</h2><div class="namespace"><h3><a href="html-to-md.blogger-to-md.html">html-to-md.blogger-to-md</a></h3><div class="doc"><div class="markdown"><p>Convert blogger posts to Markdown format, omitting all the Blogger chrome and navigation.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="html-to-md.blogger-to-md.html#var-blogger-dispatcher">blogger-dispatcher</a> </li><li> <a href="html-to-md.blogger-to-md.html#var-blogger-scraper">blogger-scraper</a> </li><li> <a href="html-to-md.blogger-to-md.html#var-image-table-processor">image-table-processor</a> </li></ul></div></div><div class="namespace"><h3><a href="html-to-md.core.html">html-to-md.core</a></h3><div class="doc"><div class="markdown"><p>Top level functions intended for very simple use.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="html-to-md.core.html#var-blogger-to-md">blogger-to-md</a> </li><li> <a href="html-to-md.core.html#var-html-to-md">html-to-md</a> </li></ul></div></div><div class="namespace"><h3><a href="html-to-md.html-to-md.html">html-to-md.html-to-md</a></h3><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="index"><p>Public variables and functions:</p><ul><li> <a href="html-to-md.html-to-md.html#var-markdown-a">markdown-a</a> </li><li> <a href="html-to-md.html-to-md.html#var-markdown-br">markdown-br</a> </li><li> <a href="html-to-md.html-to-md.html#var-markdown-code">markdown-code</a> </li><li> <a href="html-to-md.html-to-md.html#var-markdown-default">markdown-default</a> </li><li> <a href="html-to-md.html-to-md.html#var-markdown-dispatcher">markdown-dispatcher</a> </li><li> <a href="html-to-md.html-to-md.html#var-markdown-div">markdown-div</a> </li><li> <a href="html-to-md.html-to-md.html#var-markdown-em">markdown-em</a> </li><li> <a href="html-to-md.html-to-md.html#var-markdown-h1">markdown-h1</a> </li><li> <a href="html-to-md.html-to-md.html#var-markdown-h2">markdown-h2</a> </li><li> <a href="html-to-md.html-to-md.html#var-markdown-h3">markdown-h3</a> </li><li> <a href="html-to-md.html-to-md.html#var-markdown-h4">markdown-h4</a> </li><li> <a href="html-to-md.html-to-md.html#var-markdown-h5">markdown-h5</a> </li><li> <a href="html-to-md.html-to-md.html#var-markdown-h6">markdown-h6</a> </li><li> <a href="html-to-md.html-to-md.html#var-markdown-header">markdown-header</a> </li><li> <a href="html-to-md.html-to-md.html#var-markdown-html">markdown-html</a> </li><li> <a href="html-to-md.html-to-md.html#var-markdown-img">markdown-img</a> </li><li> <a href="html-to-md.html-to-md.html#var-markdown-ol">markdown-ol</a> </li><li> <a href="html-to-md.html-to-md.html#var-markdown-omit">markdown-omit</a> </li><li> <a href="html-to-md.html-to-md.html#var-markdown-pre">markdown-pre</a> </li><li> <a href="html-to-md.html-to-md.html#var-markdown-strong">markdown-strong</a> </li><li> <a href="html-to-md.html-to-md.html#var-markdown-ul">markdown-ul</a> </li></ul></div></div><div class="namespace"><h3><a href="html-to-md.transformer.html">html-to-md.transformer</a></h3><div class="doc"><div class="markdown"><p>The actual transformation engine, which is actually far more general than just something to generate <a href="https://daringfireball.net/projects/markdown/">Markdown</a>. It isnt as general as <a href="https://www.w3.org/standards/xml/transformation">XSL-T</a> but can nevertheless do a great deal of transformation on [HT|SG|X]ML documents.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="html-to-md.transformer.html#var-process">process</a> </li><li> <a href="html-to-md.transformer.html#var-transform">transform</a> </li></ul></div></div></div></body></html>