video.js

1
"use strict";
2

3
const pkg = require('./package.json');
4

5
module.exports = {
6
  source: {
7
    include: ['src/js/'],
8
    includePattern: '.js$',
9
  },
10
  opts: {
11
    destination: 'docs/api',
12
    readme: 'docs/index.md',
13
    template: 'node_modules/clean-jsdoc-theme',
14
    package: '',
15
    recurse: true,
16
    encoding: 'utf8',
17
    theme_opts: {
18
      homepageTitle: 'Video.js API docs',
19
      menu: [
20
        {
21
          title: 'Video.js website',
22
          link: 'https://videojs.com',
23
          class: 'link-vjs',
24
        },
25
        {
26
          title: `v${pkg.version} source`,
27
          link: 'https://github.com/videojs/video.js',
28
          class: 'link-gh',
29
        },
30
        {
31
          title: 'Twitter',
32
          link: 'https://twitter.com/videojs',
33
          class: 'link-tw',
34
        },
35
      ],
36
      favicon: 'https://videojs.com/favicon.ico',
37
      footer:
38
        '<span class="copyright"><a href="https://videojs.com">Video.js</a> is a free and open source HTML5 video player. © <a href="https://brightcove.com" target="_blank">Brightcove, Inc</a>. <a href="https://github.com/videojs/video.js/blob/master/LICENSE" class="button blue" target="_blank">View license</a></span>',
39
      include_css: ['./build/docs/styles/videojs.css'],
40
      displayModuleHeade: true,
41
      meta: [
42
        {
43
          name: 'name',
44
          content: 'Video.js API documentation',
45
        },
46
        {
47
          name: 'description',
48
          content:
49
            `Generated API documentation for the latest version of Video.js (${pkg.version}).`,
50
        },
51
      ],
52
    },
53
  },
54
  templates: {
55
    default: {
56
      staticFiles: {
57
        include: ['build/docs/'],
58
      },
59
    },
60
  },
61
  plugins: [
62
    'plugins/markdown',
63
    'build/jsdoc-typeof-plugin',
64
    'build/jsdoc-workarounds',
65
  ],
66
  markdown: {
67
    tags: ['example'],
68
    idInHeadings: true,
69
  },
70
};
71