feat: add documentation (#8593)

This commit is contained in:
jrandolf
2022-07-01 13:52:39 +02:00
committed by GitHub
parent 51ae338acd
commit 066f440ba7
781 changed files with 55939 additions and 7515 deletions

View File

@@ -39,17 +39,16 @@
"test:types": "tsc -b test-d",
"prepublishOnly": "npm run build",
"prepare": "node typescript-if-required.js && ([[ $HUSKY = 0 ]] || husky install)",
"lint": "npm run build && npm run lint:eslint && npm run doc && npm run lint:prettier",
"lint": "npm run build && npm run lint:eslint && npm run lint:prettier",
"lint:prettier": "prettier --check .",
"lint:eslint": "([ \"$CI\" = true ] && eslint --ext js --ext ts --quiet -f codeframe . || eslint --ext js --ext ts .)",
"lint:eslint:fix": "eslint --ext js --ext ts --fix .",
"install": "node install.js",
"generate:types": "node utils/export_all.js && api-extractor run --local --verbose",
"generate:esm-package-json": "echo '{\"type\": \"module\"}' > lib/esm/package.json",
"generate:docs": "npm run generate:types && node utils/remove-tag.js",
"generate:docs:testing": "commonmark docs/api.md > docs/api.html",
"generate:markdown": "ts-node -O '{\"module\":\"commonjs\"}' utils/generate_docs.ts && prettier --ignore-path none --write docs",
"docs": "npm run build && npm run generate:markdown",
"format": "prettier --write .",
"doc": "node utils/doclint/cli.js",
"commitlint": "commitlint --from=HEAD~1",
"clean:lib": "rimraf lib",
"build": "npm run build:tsc && npm run generate:types && npm run generate:esm-package-json",
@@ -82,8 +81,9 @@
"devDependencies": {
"@commitlint/cli": "17.0.1",
"@commitlint/config-conventional": "17.0.2",
"@microsoft/api-documenter": "7.17.16",
"@microsoft/api-documenter": "7.18.0",
"@microsoft/api-extractor": "7.24.2",
"@microsoft/api-extractor-model": "7.21.0",
"@types/debug": "4.1.7",
"@types/diff": "5.0.2",
"@types/mime": "2.0.3",
@@ -94,6 +94,7 @@
"@types/progress": "2.0.5",
"@types/proxy-from-env": "1.0.1",
"@types/rimraf": "3.0.2",
"@types/semver": "7.3.10",
"@types/sinon": "10.0.11",
"@types/tar-fs": "2.0.1",
"@types/unbzip2-stream": "1.4.0",
@@ -123,6 +124,7 @@
"pixelmatch": "5.3.0",
"pngjs": "6.0.0",
"prettier": "2.6.2",
"semver": "7.3.7",
"sinon": "14.0.0",
"source-map-support": "0.5.21",
"text-diff": "1.0.1",