vigour-doc/lib/index.js

A collection of tools to help make great docs with minimal effort

'use strict'

var Config = require('vigour-config')
var escapeRE = require('./escapeRE')

module.exports = exports = Doc

function Doc (_config) {
  if (!(_config instanceof Config)) {
    this.config = new Config(_config)
  }
  if (!this.config.wd.val) {
    this.config.set({
      wd: process.cwd()
    })
  }
  console.log('CONFIG', this.config.serialize())
}

Doc.prototype.start = require('./start')

Doc.prototype.mdCommentStart = "\n<!-- DON'T EDIT THIS SECTION (including comments), INSTEAD RE-RUN `vdoc` TO UPDATE -->"

Doc.prototype.mdCommentEnd = '\n\n<!-- VDOC END -->'

Doc.prototype.generatedRE = new RegExp(escapeRE(Doc.prototype.mdCommentStart) +
    '[\\S\\s]+?' + escapeRE(Doc.prototype.mdCommentEnd), 'g')

Doc.prototype.clean = require('./clean')

// Plugins

Doc.prototype.plugins = {
  jsdoc: require('./plugins/jsdoc'),
  badges: require('./plugins/badges')
}