doq

1.0.1 • Public • Published

Doq

Easy documentation using markdown.

Usage

Simple example

var doq = require('doq');
 
doq({
    templates: [
        { name: 'templates/header.html' },
        { name: 'templates/index.md' },
        { name: 'templates/footer.html' },
    ],
    output: 'index.html',
});

Livereload example

var doq        = require('doq')
  , debug      = true
  , livereload = ''
;
 
if (debug)
    livereload = '<script src="http://localhost:' + livereloadPort + '/livereload.js"></script>';
 
doq({
      templates: [
        { name: 'templates/header.html', data: { livereload: livereload, }},
        { name: 'index.md' },
        { name: 'templates/footer.html' },
    ],
    output: 'index.html',
    debug: debug,
    templateRoot: 'templates/',
});

Command line usage

Usage:
  doq [--output=<output>] [--data=<data>] [--debug] <templates>...
  doq -h | --help
  doq --version

Simple example:

doq header.html body.md footer.html --output index.html

Versions

Current Tags

  • Version
    Downloads (Last 7 Days)
    • Tag
  • 1.0.1
    1
    • latest

Version History

  • Version
    Downloads (Last 7 Days)
    • Published
  • 1.0.1
    1
  • 1.0.0
    0
  • 0.1.1
    0
  • 0.1.0
    0

Package Sidebar

Install

npm i doq

Weekly Downloads

1

Version

1.0.1

License

BSD

Unpacked Size

6.07 kB

Total Files

10

Last publish

Collaborators

  • reimund