mochajs/mocha-docdash

Name: mocha-docdash

Owner: Mocha

Description: Mocha Jsdoc template

Created: 2018-04-12 21:46:55.0

Updated: 2018-04-21 05:39:55.0

Pushed: 2018-04-21 05:39:53.0

Homepage: https://mochajs.org/api

Size: 240

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

@mocha/docdash

A jsdoc template for Mocha, forked from docdash

Install

m install @mocha/docdash

Usage

Clone repository to your designated jsdoc template directory, then:

doc entry-file.js -t path/to/mocha-docdash

Usage (npm)

In your projects package.json file add a new script:

ipt": {
enerate-docs": "node_modules/.bin/jsdoc -c jsdoc.json"

In your jsdoc.json file, add a template option.

s": {
emplate": "node_modules/@mocha/docdash"

Sample jsdoc.json

See the config file for the fixtures or the sample below.

"tags": {
    "allowUnknownTags": false
},
"source": {
    "include": "../js",
    "includePattern": ".js$",
    "excludePattern": "(node_modules/|docs)"
},
"plugins": [
    "plugins/markdown"
],
"opts": {
    "template": "node_modules/@mocha/docdash",
    "encoding": "utf8",
    "destination": "docs/",
    "recurse": true,
    "verbose": true
},
"templates": {
    "cleverLinks": false,
    "monospaceLinks": false
}

Options

Docdash supports the following options:

"docdash": {
    "static": [false|true],  // Display the static members inside the navbar
    "sort": [false|true]     // Sort the methods in the navbar
}

Place them anywhere inside your jsdoc.json file.

License

Licensed under the Apache License, version 2.0. (see Apache-2.0).