docs-images
TQ1 document generator
Last updated 3 years ago by taqtile .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install docs-images 
SYNC missed versions from official npm registry.

Doc Images

NPM

Usage

  1. Add npm install docs-images to you package.json

  2. Create the text file with mermaid`. Try using the editor.

  3. Call the require var tq1docs = require('br-tq1-doc-images');. To generate the images, call the method tq1docs.generate passing the configuration object and a callback function. The options is:

  • source_path: path to the text files
  • source_extension: files extension
  • images_path: output images path

Example

var docs = require('docs-images');
docs.generate({
  source_path: './src',
  source_extension: 'txt',
  images_path: './images'
}, function(err) {
  if (err) {
    console.log('errr generating docs: ' + err);
  } else {
    console.log('docs generated :)');
  }
});

Current Tags

  • 1.1.0                                ...           latest (3 years ago)

4 Versions

  • 1.1.0                                ...           3 years ago
  • 1.0.2                                ...           3 years ago
  • 1.0.1                                ...           3 years ago
  • 1.0.0                                ...           5 years ago
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 0
Dependencies (6)
Dev Dependencies (8)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |