summaryrefslogtreecommitdiff
path: root/node_modules/snekfetch/docs.js
blob: 06b28761a2f3a2999ec68a82a6ec7135c8ead669 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
const Docma = require('docma');
const Package = require('./package');

Docma.create()
  .build({
    app: {
      title: Package.name,
      base: '/',
      entrance: 'content:readme',
      routing: 'query',
      server: Docma.ServerType.GITHUB,
    },
    markdown: {
      gfm: true,
      tables: true,
      breaks: false,
      pedantic: false,
      sanitize: false,
      smartLists: false,
      smartypants: false,
      tasks: false,
      emoji: true,
    },
    src: [
      { readme: './README.md' },
      { snekfetch: './src/index.js' },
    ],
    dest: './docs',
    jsdoc: {
      plugins: ['jsdoc-dynamic'],
    },
    template: {
      options: {
        title: Package.name,
        navItems: [
          {
            label: 'Readme',
            href: '?content=readme',
          },
          {
            label: 'Documentation',
            href: '?api=snekfetch',
            iconClass: 'ico-book',
          },
          {
            label: 'GitHub',
            href: Package.homepage,
            target: '_blank',
            iconClass: 'ico-md ico-github',
          },
        ],
      },
    },
  })
  .catch(console.error); // eslint-disable-line no-console