Skip to content

Commit

Permalink
Update docs, doesn't work well
Browse files Browse the repository at this point in the history
  • Loading branch information
charlesLoder committed Mar 28, 2024
1 parent df24b46 commit 91e8877
Show file tree
Hide file tree
Showing 3 changed files with 76 additions and 4 deletions.
65 changes: 65 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@
"prepublishOnly": "npm test && npm run lint",
"preversion": "./changelog.sh && npm run format && npm run lint && npm test",
"postversion": "git push && git push --tags",
"docs": "typedoc",
"docs": "typedoc && cp havarot-2400.png ./docs",
"update": " npm-check-updates '/^(?!typedoc).*$/' -u"
},
"files": [
Expand All @@ -109,6 +109,7 @@
"license": "MIT",
"devDependencies": {
"@alcalzone/esm2cjs": "^1.1.2",
"@droppedcode/typedoc-plugin-copy-assets": "^1.0.11",
"@types/jest": "^29.5.12",
"@typescript-eslint/eslint-plugin": "^7.1.1",
"eslint": "^8.57.0",
Expand All @@ -121,6 +122,7 @@
"ts-jest": "^29.1.2",
"tsc-alias": "^1.8.8",
"typedoc": "^0.25.10",
"typedoc-material-theme": "^1.0.2",
"typedoc-plugin-pages-fork": "^0.0.1",
"typescript": "^5.3.3"
}
Expand Down
11 changes: 8 additions & 3 deletions typedoc.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,16 @@
{
"$schema": "https://typedoc.org/schema.json",
"includeVersion": true,
"entryPoints": ["src/"],
"exclude": ["src/utils", "src/index.ts", "src/node.ts"],
"entryPointStrategy": "expand",
"exclude": ["src/utils/*.ts", "src/index.ts", "src/node.ts", "src/schemas.ts"],
"out": "docs",
"theme": "pages-plugin",
"plugin": ["typedoc-material-theme"],
"themeColor": "#f0f0f0",
"excludePrivate": true,
"excludeProtected": true,
"sort": ["instance-first"],
"excludeNotDocumented": true,
"excludeNotDocumentedKinds": ["Module"],
"sort": ["alphabetical"],
"readme": "./pages/introduction.md"
}

0 comments on commit 91e8877

Please sign in to comment.