|
| 1 | +const path = require("path") |
| 2 | + |
| 3 | +/** @type {import('typedoc').TypeDocOptions} */ |
| 4 | +module.exports = { |
| 5 | + name: "Simple Scaffold", |
| 6 | + entryPoints: ["src/index.ts"], |
| 7 | + includeVersion: true, |
| 8 | + categorizeByGroup: false, |
| 9 | + sort: ["visibility"], |
| 10 | + categoryOrder: ["Main", "*"], |
| 11 | + media: "media", |
| 12 | + githubPages: true, |
| 13 | + entryPointStrategy: "expand", |
| 14 | + out: "docs", |
| 15 | + excludePrivate: true, |
| 16 | + excludeProtected: true, |
| 17 | + excludeInternal: true, |
| 18 | + gaID: "GTM-KHQS9TQ", |
| 19 | + validation: { |
| 20 | + invalidLink: true, |
| 21 | + }, |
| 22 | + plugin: ["@knodes/typedoc-plugin-pages"], |
| 23 | + customCss: "src/docs.css", |
| 24 | + options: "typedoc.config.js", |
| 25 | + logLevel: "Verbose", |
| 26 | + pluginPages: { |
| 27 | + logLevel: "Verbose", |
| 28 | + pages: [ |
| 29 | + { |
| 30 | + name: "Configuration", |
| 31 | + source: "README.md", |
| 32 | + childrenDir: path.join(process.cwd(), "pages"), |
| 33 | + childrenOutputDir: "./", |
| 34 | + children: [ |
| 35 | + { |
| 36 | + name: "CLI usage", |
| 37 | + source: "cli.md", |
| 38 | + }, |
| 39 | + { |
| 40 | + name: "Node.js usage", |
| 41 | + source: "node.md", |
| 42 | + }, |
| 43 | + { |
| 44 | + name: "Templates", |
| 45 | + source: "templates.md", |
| 46 | + }, |
| 47 | + { |
| 48 | + name: "Configuration Files", |
| 49 | + source: "configuration_files.md", |
| 50 | + }, |
| 51 | + { |
| 52 | + name: "Migrating 0.x to v1.x", |
| 53 | + source: "migration.md", |
| 54 | + }, |
| 55 | + ], |
| 56 | + }, |
| 57 | + { |
| 58 | + name: "Changelog", |
| 59 | + source: "./CHANGELOG.md", |
| 60 | + }, |
| 61 | + ], |
| 62 | + }, |
| 63 | +} |
0 commit comments