How to switch from Markdown Extra to other Markdown flavors?
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.2k
- Forks
- 146
- PR merge metrics
- No merged PRs in 30d
Description
Expected Behavior
I'd like my module docs to be rendered correctly in something like a GitHub README.md file. Problems are caused with Markdown Extra, I'd like to switch to something simpler.
Actual Behavior
The use of Markdown Extra (and specifically things like definition lists) cause Class methods (or all Class documentation, really) to render as one giant codeblock.
Steps to Reproduce
pdoc foo.pywherefoo.pyis https://gist.github.com/f0ff886f/99f504e700d2fc0ec9e3a8012d2fa3f9- Output is: https://gist.github.com/f0ff886f/dab4023f59eb54ad7e97b7b983d981e1
Additional info
- pdoc version: 0.9.1
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reproducing the issue with pdoc foo.py using the linked foo.py gist, then compare the generated output with the expected GitHub README-style rendering. Investigate how pdoc 0.9.1 selects or applies Markdown rendering, including definition lists. Done means module and class documentation render correctly and users can switch to a simpler Markdown flavor.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown, python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100