mandoc

ManDoc

Your swiss-army knife to convert documents in Markdown to PDF or HTML.

Features

This project is inspired by

• markdown-pdf
• pandoc
• DeckTape
• Hexo

Installation

$ npm install mandoc -g

Executable Package Release is also in plan for Windows Users.

Docker Image provide is also in plan for Docker Users.

Quick Start

Convert your markdown into PDF through Mandoc

$ mandoc path/to/your/doc.md
$ open path/to/your/doc.pdf

Convert a markdown bytes stream to PDF

$ curl https://raw.githubusercontent.com/chigix/mandoc/master/README.md | mandoc -o ./r.pdf

With Template to build for different situation from your original markdown

$ mandoc --template path/to/template_dir path/to/your/doc.md

Template in mandoc is similar to the concept of theme in building a web site. However mandoc is designed for converting your original markdown document into different shape of files for different situation and needs, which is mostly outputted to a single file as the final result for future usage.

About the template package, mandoc is designed to support npm packaged template release as well, which means that you can share or download other designers' template work through npm install -g tpl_name simply.

Format Specific Options

Currently, html and pdf are supported, and default output format would be pdf.

If you want html format as the output result:

$ mandoc --to html path/to/your/doc.md

Print Option Section

--pagesize SIZE, --print.pageSize SIZE : Specify the paper size for output pdf file.

SIZE format can be:

• A4
• A3 landscape
• 400mm 600mm, where the left dedicates to the width to set and the right is height

TODO

• Separate types package outside src, preparing for the future migration and typescript support in Template Script Files.
• Support YAML-Formatted Metadata Parsing
  • https://blog.github.com/2013-09-27-viewing-yaml-metadata-in-your-documents/
  • https://jekyllrb.com/docs/front-matter/

To Try

• tsconfig file series practice It seems that esm5 and esm2015 compiling result from typescript source code could be directly used for the keys, module and es2015, in package.json file.

  This practice could also be totally referenced in rxjs official repository, where different tsconfig files are prepared for compiling target as es5 and es2015.

  This attempt sounds that a little time would be cost without any apparent technical barrier that need to spend time for inspecting and learning.

• RXJS commit message guideline https://github.com/ReactiveX/rxjs/blob/master/CONTRIBUTING.md#commit-message-guidelines

• Default Slide Template Support Plan

License

MIT

Changelog

1.1.0 (2018-10-22)

Bug Fixes

• cli: support papersize option in mandoc cli (7d49356)

<a name="1.1.0-alpha.1"></a>