/
README.html
34 lines (34 loc) · 1.99 KB
/
README.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
<h1 id="table-of-contents">Table of Contents</h1>
<ul>
<li><a href="#markzero">markzero</a></li>
</ul>
<ul>
<li><a href="#install">Install</a></li>
<li><a href="#features">Features</a></li>
<li><a href="#examples">Examples</a></li>
<li><a href="#license">License</a></li>
</ul>
<h1 id="markzero">markzero</h1>
<p>Extensions to the marked library.</p>
<p>This library extends the excellent <a href="https://github.com/chjj/marked">marked</a> markdown parser to allow round tripping markdown to tokens and back to markdown. It also provides renderers to convert markdown to plain text and man pages.</p>
<p>Used by the <a href="https://github.com/freeformsystems/cli-command">command</a> module and the <a href="https://github.com/freeformsystems/mdp">mdp</a> program.</p>
<h2 id="install">Install</h2>
<pre><code>npm%20i%20markzero
</code></pre><h2 id="features">Features</h2>
<ul>
<li>Convert markdown documents to tokens and back to markdown to programatically modify a document.</li>
<li>Additional renderers for plain text and man pages.</li>
<li>Builds link index for plain text documents.</li>
<li>Supports nested ordered lists when converting back to markdown.</li>
</ul>
<h2 id="examples">Examples</h2>
<p>Alternative versions of this document serve as examples:</p>
<ul>
<li><a href="https://github.com/freeformsystems/markzero/blob/master/doc/alt/README.txt">README.txt</a>.</li>
<li><a href="https://github.com/freeformsystems/markzero/blob/master/doc/alt/README.1">README.1</a>.</li>
<li><a href="https://github.com/freeformsystems/markzero/blob/master/doc/alt/README.html">README.html</a>.</li>
<li><a href="https://github.com/freeformsystems/markzero/blob/master/doc/alt/README.xhtml">README.xhtml</a>.</li>
</ul>
<h2 id="license">License</h2>
<p>Everything is <a href="http://en.wikipedia.org/wiki/MIT_License">MIT</a>. Read the <a href="https://github.com/freeformsystems/markzero/blob/master/LICENSE">license</a> if you feel inclined.</p>
<p>Generated by <a href="https://github.com/freeformsystems/mdp">mdp(1)</a>.</p>