jsdoc.config.js

/* global require, module */

const fs = require('fs-extra');

// Empty "doc" and copy "ico.png"
fs.emptyDirSync('doc');

module.exports = {
  source: {
    include: ['misc/jsdoc/index.md', 'src'],
    includePattern: '.+\\.js$',
    exclude: ['src/GlobalData.js'],
  },
  opts: {
    recurse: true,
    verbose: true,
    destination: 'doc',
    template: 'node_modules/clean-jsdoc-theme',
  },
  tags: {
    allowUnknownTags: true
  },
  plugins: ['plugins/markdown'],
  templates: {
    systemName: 'JClic.js',
    applicationName: 'JClic.js',
    footer: '',
    copyright: '',
    includeDate: false,
    dateFormat: 'ddd MMM Do YYYY',
    navType: 'inline',
    theme: 'united',
    linenums: true,
    collapseSymbols: false,
    inverseNav: true,
    outputSourceFiles: true,
    outputSourcePath: true,
    default: {
      outputSourceFiles: true
    },
    syntaxTheme: 'default',
    sort: true,
    search: true,

    cleverLinks: true,
    monospaceLinks: true,
    disqus: '',
    //analytics: { ua: 'UA-XXXXX-XXX', domain: 'XXXX' },
    googleAnalytics: '',
    highlightTutorialCode: true,
    protocol: 'html://',
    openGraph: {
      title: '',
      type: 'website',
      image: '',
      site_name: '',
      url: ''
    },
    meta: {
      title: '',
      description: '',
      keyword: ''
    }
  },
  markdown: {
    parser: 'gfm',
    hardwrap: true,
    tags: ['examples']
  }
};