Skip to content

Commit 9b86499

Browse files
committed
docs: use js for typedoc config
1 parent f41ebfb commit 9b86499

3 files changed

Lines changed: 67 additions & 71 deletions

File tree

pages/migration.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,10 @@ between versions. With these notable exceptions:
1111

1212
- `locals` has been renamed to `data`. The appropriate command line args have been updated as well
1313
to `--data` | `-d`.
14-
- Additional options have been added to both CLI and Node interfaces. See the [readme](/README.md)
15-
for more information.
14+
- Additional options have been added to both CLI and Node interfaces. See
15+
[Command Line Interface (CLI) usage](https://chenasraf.github.io/simple-scaffold/pages/cli.html)
16+
and [Node.js usage](https://chenasraf.github.io/simple-scaffold/pages/node.html) for more
17+
information.
1618

1719
## Template syntax changes
1820

typedoc.config.js

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
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+
}

typedoc.json

Lines changed: 0 additions & 69 deletions
This file was deleted.

0 commit comments

Comments
 (0)