Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(docs): Documentation package upgrades and updates (#608)
Typedoc related package upgrades: - Upgrade typedoc to v0.22.7 everywhere including all packages. - Upgrade typedoc-plugin-markdown to v3.11.3. - Remove typedoc plugins that are unsupported in typedoc v0.22.7. - typedoc-plugin-monorepo: typedoc has added basic support for monorepos with entryPointStrategy. There's an open github issue for typedoc v0.22.7 support, but currently is not compatible. - typedoc-neo-theme: v0.22.0 introduced a breaking change for all custom themes. Use the default theme until typedoc-neo-theme is updated for v0.22.7. Consolidate typedoc options in tsconfig.json for all packages. No need to pass options from typedoc-neo.json to typedoc. The markdown README for the subpackages are missing from the documentation. These were previously inserted via typedoc plugins, but there is an issue open for typedoc slated for the v0.24.0 relase. Typedoc now provides some tooling for monorepos (entryPoints, entryPointStrategy, typedocMain). This means that only the exports in the file specified in typedocMain are now documented. Add add a commit msg when deploying docs via gh-pages to skip ci. The following typedoc options have been removed/changed with the corresponding typedoc release in parenthesis: - mode has been removed (v0.20.0) - excludeNotExported has been removed (v0.20.0) - ignoreCompilerErrors has been removed (v0.20.0) - disableOutputCheck has been renamed to cleanOutputDir (v0.22.0) The hideSources option has been removed from typedoc-plugin-markdown around v3.2.0
- Loading branch information