typedoc-plugin-markdown
typedoc-plugin-markdown copied to clipboard
Typedoc-plugin-markdown to RestructuredFile ?
Dear @tom-grey, @Vinnl , @cancerberoSgx , @tusharmath , @jrylan
Nice work.
I am using sphinx-docs and could be nice if same plugin wwill exist for .rst file.
Best Regards, Youssef
Just reviewing old tickets. Could potentially write something to output reStructuredText if there was interest for it. Will leave open for discussion.
Interestingly when I was tagged I had no idea what Sphinx even was, but nowadays we're using it too. Our current setup is to render the Markdown generated by typedoc-plugin-markdown using MyST-Parser, which works fine, but obviously direct ReST output would be more reliable. So consider this an expression of mild interest :)
Dear Tom,
There is different flavors of markdown for example using to publish as readme.md file on GitHub or bitbucket. Bitbucket doesn't recognizes some tags or issues with TOC.
I tried the typedoc-bitbucket plugin but same, links doesn't work for table doc or not recognize some tags
If the document is in restructuredFile, I can continue to use my script to include the typedoc generated doc into my whole project.
Yes, i am still interesting for this.
Best regards
@yboujraf ok this could be an interesting project. i will probably need to pick your brains once I have investigated a bit further.
Dear
You are welcome
Looks like there has been some movement on this
sphinx-js also works with TypeScript, using the TypeDoc tool in place of JSDoc and emitting all the type information you would expect.
https://github.com/mozilla/sphinx-js
In any case going to close this one here.