Code blocks broken inside markdown `!!! note` admonitions
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.2k
- Forks
- 146
- PR merge metrics
- No merged PRs in 30d
Description
Expected Behavior
Markdown is parsed properly
Actual Behavior
Weird behavior happens or wrong language gets parsed
Steps to Reproduce
-
Have a
!!! notewith a codeblock in it.
-
Build the html and look at the output.
Additional notes
Intending the codeblock causes it to be detected as shell
Also detects it as shell if you only intent it, even without the codeblock
You can see a repo here: repro_API_documentation.txt
NOTE: Github doesnt allow uploading html, so you will have to download that and rename the extension to .html to view it
Additional info
- pdoc version: 0.8.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 with the attached repro_API_documentation.txt and generate its HTML using pdoc 0.8.1, then compare code blocks inside !!! note admonitions with the reported output. Trace the Markdown-to-HTML entry point responsible for admonitions and code-block language detection. Done means indented code blocks in admonitions render correctly and keep their intended language rather than being detected as shell.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown, python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100