dt
doc-templater
npm i doc-templater
dt

doc-templater

Creates organized HTML documentation templates from sections of Github flavored markdown

by Nicholas Crumrine

0.4.0 (see all)License:MITTypeScript:Not Found
npm i doc-templater
Readme

(md) icon, representing the markdown syntax doc-templater

NPM version     Build Status

Compiles a tree of Github-flavored markdown files into themable HTML templates. Supports pulling directly from multiple remote or local git repositories and exposes lifecycle hooks for transforming markdown input (beforeConvert) or HTML output (afterConvert). Also writes flat tree arrays representing the directory hierarchy as JSON files (these are saved as .jsmenu files currently, but never fear, they're just normal JSON).

This module is used for the official Sails website at http://sailsjs.org.

Installation

$ npm install doc-templater --save

Usage

require('doc-templater')().build({
  remote: 'git@github.com:balderdashy/sails.git',
  remoteSubPath: '',
  branch: 'master',
  cachePath: '/code/sandbox/doctemplatertest/foo/bar/cache/',
  htmlDirPath: '/code/sandbox/doctemplatertest/foo/bar/html',
  jsMenuPath: '/code/sandbox/doctemplatertest/foo/bar.jsmenu'
}, function (err,result) {
  // If something went wrong...
  if (err) {
    console.log('ERROR:\n',require('util').inspect(err, false, null));
    return;
  }
  
  // Otherwise, it worked!
  console.log('RESULT:\n',require('util').inspect(result, false, null));
});

Changelog

#####v0.1.0 August 2014

Refactored to use smaller, more testable modules and enhance stability. Also added some caching/performance improvements.

#####v0.0.9 May 2014

Now supports git branches, infinitely deep docs directories, and outputting json menus with template metaData attached (use <docmeta name="keyname" value="keyvalue"> inside of templates).

License

MIT © 2013-2015 Nicholas Crumrine, Mike McNeil & contributors

This module is an official part of the Sails framework ecosystem, and is free and open-source under the MIT License.

image_squidhome@2x.png

Downloads/wk

24

GitHub Stars

19

LAST COMMIT

4yrs ago

MAINTAINERS

6

CONTRIBUTORS

101

OPEN ISSUES

2

OPEN PRs

0
VersionTagPublished
0.4.0
latest
6yrs ago
No alternatives found
No tutorials found
Add a tutorial

Rate & Review

100
No reviews found
Be the first to rate