Skip to content

Commit

Permalink
docs: updated typedoc to latest beta version with built-in pages support
Browse files Browse the repository at this point in the history
  • Loading branch information
AlansCodeLog committed May 27, 2024
1 parent 807b96d commit 95e704d
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 20 deletions.
4 changes: 4 additions & 0 deletions docs-src/DEVELOPMENT.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
title: Development
group: Guides
---
## File Structure

This library makes use of a custom index file manager I wrote, called [indexit](https://github.com/alanscodelog/indexit).
Expand Down
3 changes: 1 addition & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,6 @@
"@alanscodelog/eslint-config": "5.0.0-beta.2",
"@alanscodelog/semantic-release-config": "^4.1.2",
"@alanscodelog/tsconfigs": "^4.0.1",
"@knodes/typedoc-plugin-pages": "^0.23.4",
"@types/node": "^20.4.1",
"@vitest/coverage-v8": "^1.6.0",
"commitlint": "^19.3.0",
Expand All @@ -106,7 +105,7 @@
"semantic-release": "^23.1.1",
"ts-node": "^10.9.1",
"tsc-alias": "^1.8.7",
"typedoc": "~0.23.1",
"typedoc": "0.26.0-beta.1",
"typescript": "~5.4.5",
"vite": "^5.2.11",
"vite-plugin-externalize-deps": "^0.8.0",
Expand Down
21 changes: 3 additions & 18 deletions typedoc.config.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -28,22 +28,7 @@ module.exports = {
validation: {
invalidLink: true,
},
pluginPages: {
source: "docs-src",
pages: [
{
name: "Additional Docs",
children: [
// {
// name: "Internal Docs",
// source: "internal_docs.md",
// },
{
name: "Development",
source: "DEVELOPMENT.md",
},
],
},
],
},
projectDocuments: [
"docs-src/DEVELOPMENT.md",
]
}

0 comments on commit 95e704d

Please sign in to comment.