simple-scaffold/typedoc.config.js at master · chenasraf/simple-scaffold · GitHub

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
56
57
58
59
60
61
62
63
const path = require("node:path")

/** @type {import('typedoc').TypeDocOptions} */
module.exports = {
  name: "Simple Scaffold",
  entryPoints: ["src/index.ts"],
  includeVersion: true,
  categorizeByGroup: false,
  sort: ["visibility"],
  categoryOrder: ["Main", "*"],
  media: "media",
  githubPages: true,
  entryPointStrategy: "expand",
  out: "docs",
  excludePrivate: true,
  excludeProtected: true,
  excludeInternal: true,
  gaID: "GTM-KHQS9TQ",
  validation: {
    invalidLink: true,
  },
  plugin: ["@knodes/typedoc-plugin-pages"],
  customCss: "src/docs.css",
  options: "typedoc.config.js",
  logLevel: "Verbose",
  pluginPages: {
    logLevel: "Verbose",
    pages: [
      {
        name: "Configuration",
        source: "README.md",
        childrenDir: path.join(process.cwd(), "pages"),
        childrenOutputDir: "./",
        children: [
          {
            name: "CLI usage",
            source: "cli.md",
          },
          {
            name: "Node.js usage",
            source: "node.md",
          },
          {
            name: "Templates",
            source: "templates.md",
          },
          {
            name: "Configuration Files",
            source: "configuration_files.md",
          },
          {
            name: "Migrating v0.x to v1.x",
            source: "migration.md",
          },
        ],
      },
      {
        name: "Changelog",
        source: "./CHANGELOG.md",
      },
    ],
  },
}