markitdown
A thin wrapper around pandoc to help you convert markdown into web pages.
Dependencies
1. Node.js (http://nodejs.org/#download)
2. Pandoc (http://johnmacfarlane.net/pandoc/installing.html)
Install
``bash
$> npm install markitdown -g
`
Usage
Convert markdown to html courtesy of pandoc.
Files will be written with the same name and a .html exension
Usage: markitdown inputFile.md
Options:
--output-path Output path.
--head file to be included in
--header file to be included just after opening
--footer file to be included just before end of
--title prepend
tags with this valu</p><p class="my-3"><h2 class="text-xl font-semibold mt-5 mb-3">Examples</h2></p><p class="my-3">As basic as it gets. Convert a single file to html. This will output </code>readme.html<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">.</p><p class="my-3"></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">bash<br />$> markitdown readme.md<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"></p><p class="my-3">Convert the markdown files in the </code>./docs<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"> directory to html and put the output in the </code>./docsweb<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"> directory.</p><p class="my-3"></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">bash<br />$> markitdown ./docs --output-path ./docsweb<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"></p><p class="my-3">Convert a single file to html, but insert html content into the top of the page. Useful for common navigation, headers, logos, etc.</p><p class="my-3"></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">bash<br />$> markitdown readme.md --header ./header.html<br /></code>``</p><p class="my-3"><h2 class="text-xl font-semibold mt-5 mb-3">Sample output</h2></p><p class="my-3">Wouldn't that be nice! Will add some to the gh-pages branch in the future.</p></div></div></div><div data-state="inactive" data-orientation="horizontal" role="tabpanel" aria-labelledby="radix-_R_aav5ubrb_-trigger-dependencies" hidden="" id="radix-_R_aav5ubrb_-content-dependencies" tabindex="0" data-slot="tabs-content" class="flex-1 outline-none mt-6"></div><template id="P:3"></template></div></div></div><div hidden id="S:3"><div data-state="inactive" data-orientation="horizontal" role="tabpanel" aria-labelledby="radix-_R_aav5ubrb_-trigger-versions" hidden="" id="radix-_R_aav5ubrb_-content-versions" tabindex="0" data-slot="tabs-content" class="flex-1 outline-none mt-6"></div></div><script>$RS=function(a,b){a=document.getElementById(a);b=document.getElementById(b);for(a.parentNode.removeChild(a);a.firstChild;)b.parentNode.insertBefore(a.firstChild,b);b.parentNode.removeChild(b)};$RS("S:3","P:3")</script><script>$RC("B:1","S:1")</script></body></html>