@appcominteractive/appcom-pandoc-npm

Appdoc

Appdoc (Appcom Pandoc) is a module for converting markdown to html using pandoc. So make sure that pandoc is installed and that the binary is available (i.e. it is set in the path).

Converting markdown to html via pandoc is not that hard. But we often found that configuring it the right way is cumbersome. Hence we created this module to do it for us. It applies a beautiful html and css template and sets a proper configuration, which is

• Enable table of contents and set depth to 1
• Make html stand alone and self contained, to not rely on external sources, likes images and css
• Automatically number headlines
• Set variables version and date, which can be used within the template

Installation

npm install @appcominteractive/appcom-pandoc-npm

Usage

Create a valid markdwon file, which can be converted by pandoc. Then execute the following command on your terminal

appdoc html /path/to/file.md [outputfilename]

That's it. Enjoy your beautiful html document from your markdown file.

Roadmap

• Set proper version via git tag or by cli option
• Override html and css template if needed

License

Copyright 2017 appcom interactive GmbH

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.