typedoc
typedoc copied to clipboard
TypeStrong
Add support for adding markdown pages
Search Terms
pages, markdown, md
Problem
Similar issue was reported earlier as well. However, it was closed citing a plugin. However, the plugins developed for one version do not work with the other. Also, we don't want to be locked to lower version of TypeScript to use Typedoc with lower version.
Suggested Solution
Please create a feature to automatically pick up markdown files from specified directory or path and include that in documentation.
As of now, I just employed a quick hack - https://react18-tools.github.io/react18-global-store/
This suggests that it shouldn't be very difficult to add this feature with a little better aesthetics to the library.
Duplicate of #247, this is the feature I'm hoping to include in the next typedoc minor release.
Thanks. Let me know if I can help in any way. Do you have any open PR for this that I can review and see if I can add anything to it?
Nothing up yet, I'm hoping to get to a working POC this weekend, or possibly the next.
0.26.0-beta.0 is up with this, announcement at https://github.com/TypeStrong/typedoc/issues/2567