jsdoc-template-ship-shape

A JSDoc Template for Pretty Docs

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
jsdoc-template-ship-shape
000.1.15 years ago5 years agoMinified + gzip package size for jsdoc-template-ship-shape in KB

Readme

jsdoc-template-ship-shape
A JSDoc Template for pretty docs
Example config:
//.jsdoc.js

'use strict';

module.exports = {
  tags: {
    allowUnknownTags: true,
    dictionaries: ['jsdoc']
  },
  source: {
    include: [
      'package.json',
      'README.md',
      './src/js/shepherd.js',
      './src/js/step.js',
      './src/js/tour.js'
    ]
  },
  plugins: [
    'plugins/markdown'
  ],
  sourceType: 'module',
  templates: {
    referenceTitle: 'Shepherd.js',
    githubLink: 'https://github.com/shipshapecode/shepherd',
    // Do not disable sorting
    disableSort: false,
    // Do not collapse, show all methods
    collapse: false,
    resources: {
      Demo: 'https://shepherdjs.dev/demo/'
    }
  },
  opts: {
    destination: './docs/',
    encoding: 'utf8',
    // Do not include functions marked `@private`
    private: false,
    recurse: true,
    template: './node_modules/jsdoc-template-ship-shape',
    tutorials: './docs-src/tutorials'
  }
};