@denali-js/documenter

Generate docs data from a Javascript or Typescript project

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
30Mar 6, 2018Oct 20, 2017Minified + gzip package size for @denali-js/documenter in KB

Readme

Documenter

Travis Dependencies npm downloads latest version

Generate documentation for your JavaScript or Typescript projects!

Includes support for API reference docs generated automatically from code comments, as well as Markdown guides.

Documenter does not generate HTMl or any other kind of rendered output - it only extracts the documentation from your codebase and supplies it in a structured, consistent format for you to render as you wish.

Used by the Denali CLI to generate documentation for Denali projects, but it's not tied to Denali projects only.

Usage

You can use the extracter directly:

import { Extracter } from 'documenter';

let extracter = new Extracter({

  // The base directory to start everything from
  dir: process.cwd(),

  // The directory to scan for Markdown files
  pagesDir: 'guides',

  // An array of glob patterns to search for source files
  sourceDirs: [ 'src' ],

  // The name of the project
  projectName: 'typescript-project',

  // The current version of the project
  projectVersion: '1.0.0'

});

let docs = extracter.extract();

Or, if you happen to be using Broccoli, you can use the Broccoli plugin:

import { ExtracterTree } from 'documenter';

// inputTree should contain the pages and source you want to extract
// All paths will be relative to the inputTree
let extracter = new ExtracterTree(inputTree, {

  // The directory to scan for Markdown files
  pagesDir: 'guides',

  // An array of glob patterns to search for source files
  sourceDirs: [ 'src' ],

  // The name of the project
  projectName: 'typescript-project',

  // The current version of the project
  projectVersion: '1.0.0'

});

// The Broccoli plugin will write out the resulting docs data to `docs.json`
// If a `docs.json` exists in the inputTree, it will simply copy that over
// and skip the extraction.

For an example of what the final docs structure looks like, check the test output helper file.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.