Strike Through Markdown not working
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.2k
- Forks
- 146
- PR merge metrics
- No merged PRs in 30d
Description
Expected Behavior
The strike through to happen
https://i.imgur.com/iZsP31F.png
Actual Behavior
The strike through does not happen, and I am left with extra ~s
https://i.imgur.com/ePnQrZj.png
Steps to Reproduce
- Create a markdown file
- Include said markdown file in one of the library's module docstrings
- generate the documentation and see the markdown not work
Additional info
If this matters, im using pdoc3 v0.10.0
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
No source file or test is named. Reproduce with pdoc3 v0.10.0 by placing strikethrough Markdown in a module docstring, generating the documentation, and comparing the output with the expected rendering shown in the issue; done means the Markdown renders without extra tildes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100