Docpiler

Document Compiler

Introduction

Docpiler is a document compiler. The intented use is to compile markdown annotated text files to html files in order to produce a functional website.

The target use cases are:

• To be used as a static site generator for blogs
• To be used as a documentation generator

In contrast with most npm packages, docpiler is supposed to be installed as a global package.

Examples will be provided in the github repo.

Project Status

This project is in alpha version. It's quite possible that the upcomming releases will break something. Please feel free to contact me directly or via github for any issues related to this package.

Usage

• In a node.js script

    const docpiler = require('docpiler');
    const doc = new docpiler(...);
    ...

• As a CLI tool with a (with a docpiler.config file)

    />docpiler

Examples

• Examples