https://github.com/shipshapecode/jsdoc-template-ship-shape

A JSDoc Template for pretty docs
https://github.com/shipshapecode/jsdoc-template-ship-shape

Last synced: 11 months ago
JSON representation

A JSDoc Template for pretty docs

• Host: GitHub
• URL: https://github.com/shipshapecode/jsdoc-template-ship-shape
• Owner: shipshapecode
• Created: 2019-07-13T15:11:22.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-03-27T12:22:31.000Z (almost 2 years ago)
• Last Synced: 2025-01-31T14:35:44.152Z (12 months ago)
• Language: CSS
• Size: 537 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# jsdoc-template-ship-shape

A JSDoc Template for pretty docs

Example config:

```js

//.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'

  }

};

```