-
|
just want to inject the documentation into the existing |
Beta Was this translation helpful? Give feedback.
Replies: 1 comment 2 replies
-
|
To create single API docs currently you need to export a single entry point. If you also want to keep merge it with your readme you can use Here is an example: https://github.com/typedoc2md/typedoc-plugin-markdown-examples |
Beta Was this translation helpful? Give feedback.
-
|
Links are dead |
Beta Was this translation helpful? Give feedback.
-
|
Link updated. |
Beta Was this translation helpful? Give feedback.
To create single API docs currently you need to export a single entry point. If you also want to keep merge it with your readme you can use
mergeReadmewhich basically prepends it to the resolved readme file.Here is an example:
https://github.com/tgreyuk/typedoc-plugin-markdown-examples/tree/main/examples/01-typedoc-plugin-markdown/05-single-page-docs-with-readmehttps://github.com/typedoc2md/typedoc-plugin-markdown-examples