how to configure typedoc to create one large markdown file for injection into existing README.md
#577
-
|
just want to inject the documentation into the existing |
Beta Was this translation helpful? Give feedback.
Answered by
tgreyuk
Feb 11, 2024
Replies: 1 comment
-
|
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: |
Beta Was this translation helpful? Give feedback.
0 replies
Answer selected by
tgreyuk
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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-readme