Markdown issues on website (API docs)
Open
Nobody has claimed this yet.
bug
- Dominant language
- MDX
- Stars
- 98
- Forks
- 298
- Avg merge
- 14h 38m
- Merged PRs (30d)
- 38
Description
Describe the bug
Parts of the Markdown content on the nf-core/tools API documentation don't render correctly.
To Reproduce
Steps to reproduce the behavior:
- Go to https://nf-co.re/docs/nf-core-tools/api_reference/dev/api/utils
- Scroll down to https://nf-co.re/docs/nf-core-tools/api_reference/dev/api/utils#pydantic-modelpythonnf_coreutilsnfcoretemplateconfigpython
- See wrong formatting directly below the "Show JSON schema" details block and further down on the site.
Expected behavior
Correct formatting of Markdown texts
Screenshots
Browser (please complete the following information):
- OS: Linux Mint
- Browser Firefox
- Version 138.0.4 (64-bit)
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
Open the nf-core/tools API documentation page and reproduce the formatting problem at the pydantic-model... anchor, especially below the “Show JSON schema” details block. Trace how the Markdown content is rendered on the website, then verify that the affected text displays with correct formatting on the documented page.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100