typedoc-plugin-markdown icon indicating copy to clipboard operation
typedoc-plugin-markdown copied to clipboard

Recommended way to match format and styles

Open jeffchuber opened this issue 2 years ago • 4 comments

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!

jeffchuber avatar May 10 '23 00:05 jeffchuber

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.

tgreyuk avatar May 12 '23 08:05 tgreyuk

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.

jeffchuber avatar May 12 '23 14:05 jeffchuber

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.

tgreyuk avatar May 12 '23 16:05 tgreyuk

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)

jeffchuber avatar May 12 '23 16:05 jeffchuber

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

tgreyuk avatar May 03 '24 17:05 tgreyuk