How to use the documentation-fork.build function in documentation-fork

To help you get started, we’ve selected a few documentation-fork examples, based on popular ways it is used in public projects.

Secure your code as it's written. Use Snyk Code to scan source code in minutes - no build needed - and fix issues immediately.

github be-fe / react-mobx-vm / scripts / doc.js View on Github external
+ '\n'
      )
    }
    return comment
  })

  return documentation.formats.md.call(this, comments)
}

var paths = argv._

var opt = {
  shallow: 's' in argv ? !!argv.s : false
}

documentation
  .build(paths, {
    hljs: {
      highlightAuto: true
    },
    shallow: opt.shallow,
    access: ['public'],
    github: true
  })
  .then(mdFormatter)
  .then(output => {
    // break line for gfm
    console.log(output.split('\n').map(line => line.trimRight()).join('  \n'))
  })
  // .then(output => {
  //   // output is a string of Markdown data
  //   fs.writeFileSync('./output.md', output)

documentation-fork

a documentation generator

ISC
Latest version published 7 years ago

Package Health Score

53 / 100
Full package analysis

Popular documentation-fork functions