popdoc

A simple Markdown to HTML converter with in-browser live preview, customizable by Node's unified framework

Usage no npm install needed!

<script type="module">
  import popdoc from 'https://cdn.skypack.dev/popdoc';
</script>

README

Popdoc

Build Status npm version npm downloads

A simple Pandoc-like Markdown to HTML converter with in-browser live preview, customizable by Node's unified framework.

Features

  • Generates a complete HTML document, not only for preview
  • Easily customize css, title, language, ..., using YAML frontmatter
  • Should be simpler than Pandoc

Install

npm install -g popdoc

Usage

Build:

popdoc example.md -o example.html

Build, preview in browser, and watch for changes:

popdoc example.md -o example.html --watch

See tests/example.md for writing a frontmatter (set title, styles, ...)

Todo

  • Use open ports
  • Support glob pattern
  • Cover necessary Pandoc features
  • Design options for unified
  • Provide good docs
  • Use TypeScript
  • Refactor

Design

  • Keep every path relative to the source document