markdown2html/readme.md

Markdown to HTML Converter

This project pulls together a number of other projects, along with some custom extensions, to provide rendering to HTML for a custom, extended version of Markdown.

These are the primary projects used to render various types of content:

• Marked
• Prism.js
• Vega
• nomnoml
• bytefield-svg
• Katex
• Pikchr
• node-qrcode

Building from source

npm run tsc

Programatic Use

import { MarkdownOptions, MarkdownExtension, render_markdown_to_html } from './build';

async function main() {
  const opts: MarkdownOptions = {
    // ...
  };

  const html = await render_markdown_to_html('# This is some markdown', opts);
}

Command Line Use

echo '# This is some markdown' | ./bin/markdown2html [...options] > output.html