Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Recommended way to match format and styles #428

Closed
jeffchuber opened this issue May 10, 2023 · 5 comments
Closed

Recommended way to match format and styles #428

jeffchuber opened this issue May 10, 2023 · 5 comments
Labels
documentation Requires examples / documentation

Comments

@jeffchuber
Copy link

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
Copy link
Member

tgreyuk commented May 12, 2023

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
Copy link
Author

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
Copy link
Member

tgreyuk commented May 12, 2023

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
Copy link
Author

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 tgreyuk added the documentation Requires examples / documentation label May 13, 2023
@tgreyuk
Copy link
Member

tgreyuk commented May 3, 2024

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

@tgreyuk tgreyuk closed this as completed May 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Requires examples / documentation
Projects
None yet
Development

No branches or pull requests

2 participants