Skip to content
This repository was archived by the owner on Mar 11, 2025. It is now read-only.

Commit 4114325

Browse files
author
Joe C
authored
type-length-value-js: add docs configs (#6289)
1 parent 35b4353 commit 4114325

File tree

4 files changed

+45
-12
lines changed

4 files changed

+45
-12
lines changed

libraries/type-length-value/js/.nojekyll

Whitespace-only changes.

libraries/type-length-value/js/package.json

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,17 +28,20 @@
2828
"import": "./lib/esm/index.js"
2929
},
3030
"scripts": {
31-
"nuke": "shx rm -rf node_modules package-lock.json || true",
32-
"reinstall": "npm run nuke && npm install",
33-
"clean": "shx rm -rf lib **/*.tsbuildinfo || true",
3431
"build": "tsc --build --verbose tsconfig.all.json",
35-
"postbuild": "shx echo '{ \"type\": \"commonjs\" }' > lib/cjs/package.json",
36-
"watch": "tsc --build --verbose --watch tsconfig.all.json",
37-
"release": "npm run clean && npm run build",
32+
"clean": "shx rm -rf lib **/*.tsbuildinfo || true",
33+
"deploy": "npm run deploy:docs",
34+
"deploy:docs": "npm run docs && gh-pages --dest type-length-value/js --dist docs --dotfiles",
35+
"docs": "shx rm -rf docs && typedoc && shx cp .nojekyll docs/",
3836
"fmt": "prettier --write '{*,**/*}.{ts,tsx,js,jsx,json}'",
3937
"lint": "prettier --check '{*,**/*}.{ts,tsx,js,jsx,json}' && eslint --max-warnings 0 .",
4038
"lint:fix": "npm run fmt && eslint --fix .",
41-
"test": "mocha test"
39+
"nuke": "shx rm -rf node_modules package-lock.json || true",
40+
"postbuild": "shx echo '{ \"type\": \"commonjs\" }' > lib/cjs/package.json",
41+
"reinstall": "npm run nuke && npm install",
42+
"release": "npm run clean && npm run build",
43+
"test": "mocha test",
44+
"watch": "tsc --build --verbose --watch tsconfig.all.json"
4245
},
4346
"dependencies": {
4447
"buffer": "^6.0.3"
@@ -59,6 +62,7 @@
5962
"prettier": "^3.2.5",
6063
"shx": "^0.3.4",
6164
"ts-node": "^10.9.2",
65+
"typedoc": "^0.25.8",
6266
"typescript": "^5.3.3"
6367
}
6468
}
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"entryPoints": ["src/index.ts"],
3+
"out": "docs",
4+
"readme": "README.md"
5+
}

pnpm-lock.yaml

Lines changed: 29 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)