popdoc

0.3.1 • Public • Published

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

  • [x] 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

/popdoc/

    Package Sidebar

    Install

    npm i popdoc

    Weekly Downloads

    1

    Version

    0.3.1

    License

    MIT

    Unpacked Size

    8.3 kB

    Total Files

    5

    Last publish

    Collaborators

    • nolze