docs: use js for typedoc config

This commit is contained in:
Chen Asraf
2023-04-25 10:15:40 +03:00
committed by Chen Asraf
parent f41ebfb1d0
commit 9b86499a04
3 changed files with 67 additions and 71 deletions

View File

@@ -11,8 +11,10 @@ between versions. With these notable exceptions:
- `locals` has been renamed to `data`. The appropriate command line args have been updated as well
to `--data` | `-d`.
- Additional options have been added to both CLI and Node interfaces. See the [readme](/README.md)
for more information.
- Additional options have been added to both CLI and Node interfaces. See
[Command Line Interface (CLI) usage](https://chenasraf.github.io/simple-scaffold/pages/cli.html)
and [Node.js usage](https://chenasraf.github.io/simple-scaffold/pages/node.html) for more
information.
## Template syntax changes

63
typedoc.config.js Normal file
View File

@@ -0,0 +1,63 @@
const path = require("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 0.x to v1.x",
source: "migration.md",
},
],
},
{
name: "Changelog",
source: "./CHANGELOG.md",
},
],
},
}

View File

@@ -1,69 +0,0 @@
{
"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.json",
"logLevel": "Verbose",
"pluginPages": {
"logLevel": "Verbose",
"pages": [
{
"name": "Configuration",
"source": "README.md",
"childrenDir": "./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 0.x to v1.x",
"source": "migration.md"
}
]
},
{
"name": "Changelog",
"source": "./CHANGELOG.md",
}
]
}
}