swagger-api / swagger-api/swagger-codegen
Static HTML generator ignores Markdown in comments
Open
Nobody has claimed this yet.
Client: HTML
Enhancement: Feature
help wanted
- Dominant language
- Mustache
- Stars
- 17.8k
- Forks
- 6k
- PR merge metrics
- No merged PRs in 30d
Description
In the attached screenshot you can see what is supposed to be a bulleted list. It may be worth mentioning that this renders correctly in the swagger-editor.
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 static HTML generator output with a comment containing the bulleted Markdown shown in the screenshot, then compare it with swagger-editor's rendering. Done means Markdown in comments is rendered as a bulleted list in the generated static HTML rather than being ignored.
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