Skip to content

Commit

Permalink
chore(docs): Increase Node memory limit for docs
Browse files Browse the repository at this point in the history
`typedoc` builds successfully on my local ARM Mac, but runs out of memory on GitHub Actions. I suspect that the limit needs to be bumped slightly to make things go for now.

This is a consequence of TypeStrong/typedoc#1606

Also includes a config change of typedoc to stop emitting source code, and to exclude functions marked as `@internal`. Plus, ESLint will now ignore built docs.
  • Loading branch information
fb55 committed Mar 18, 2022
1 parent f10a3e1 commit 64c9d28
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 1 deletion.
1 change: 1 addition & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@ test/data/html5lib-tests
test/data/html5lib-tests-fork
packages/*/dist/
test/dist/
docs/build/
node_modules
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
"build": "npm run build:esm && npm run build:cjs",
"build:esm": "tsc --build packages/* test",
"build:cjs": "tsc -p packages/parse5/tsconfig.cjs.json && echo '{\"type\":\"commonjs\"}' > packages/parse5/dist/cjs/package.json",
"build:docs": "typedoc .",
"build:docs": "node --max-old-space-size=8192 node_modules/.bin/typedoc .",
"prettier": "prettier '**/*.{js,ts,md,json,yml}' --loglevel warn",
"format": "npm run format:es && npm run format:prettier",
"format:es": "npm run lint:es -- --fix",
Expand Down
2 changes: 2 additions & 0 deletions tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@
"out": "docs/build",
"name": "parse5",
"readme": "README.md",
"emit": "docs",
"excludeInternal": true,
"entryPointStrategy": "packages"
}
}

0 comments on commit 64c9d28

Please sign in to comment.