search

typedoc2md / typedoc-plugin-markdown

A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.
https://typedoc-plugin-markdown.org
MIT License
702 stars 176 forks source link

Recommended way to match format and styles #428

Closed jeffchuber closed 4 months ago

jeffchuber commented 1 year ago

hi there,

i want to use this project to match the documentation formatting and styling coming out of pydoc-markdown.

what is the recommended way to adjusting the formatting and styling of the output?

i looked inside the project and it appears it would take significant surgery to go beyond the flags but perhaps i am missing something.

i appreciate any pointers or suggestions!

tgreyuk commented 1 year ago

Do you have any examples of what is required pydoc-markdown? On a general point yes the templates are quite coupled to the renderer but looking at splitting that out so its easier to customise.

jeffchuber commented 1 year ago

Sure! This is the formatting and styling that pydoc-markdown generates - https://docs-git-apidocs-chromacore.vercel.app/reference/local

I was hoping to have consistent styling across languages.

Probably not high priority for you - but would love any tips if you have them.

tgreyuk commented 1 year ago

Do you want to pipe some generated markdown through pydoc-markdown or just create some documentation that matches its output? If its the latter you are probably better off just trying to customise the html theme.

jeffchuber commented 1 year ago

Ideally the latter.

I did look into that, but I quickly grew afraid =D - any examples of people who have done this? (again I understand if this is not a current priority)

tgreyuk commented 4 months ago

As previously mentioned to match specific UIs with themes would require to a new HTML theme as Markdown is too restrictive.