Closed sebastianwessel closed 1 year ago
Hi - sorry not sure what those options are - they must be declared by another plugin?
It was taken from official documentation of typedoc https://typedoc.org/options/configuration/#tsconfig
TypeDoc provides its default configuration for extension in typedoc/tsdoc.json. To add a custom block tag, try:
// tsdoc.json { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "extends": ["typedoc/tsdoc.json"], "tagDefinitions": [ { "tagName": "@myCustomTag", "syntaxKind": "block" } ] }
Oh ok. You need to put the extends in a file tsdoc.json
(not typedoc.json
). Putting the extends in typedoc.json is exposing option keys that don't exist.
Ahh, ok. Thanks for the help - my fault. The most important thing - it runs, and your awesome plugin allows me to output the documentation in md 🙏
No probs :)
I've the following issues in my mono repo when creating the typedoc documentation with markdown plugin.
Without the usage of this plugin, it generates the documentation as expected.
typedoc: 0.24.6 typedoc-monorepo-link-types: 0.0.4 typedoc-plugin-markdown: 3.15.3 typescript: 5.0.4
Node v18.15.0
After removal of
"extends": ["typedoc/tsdoc.json"],
in typedoc.json it worked