swagger-api/swagger-codegen

Static HTML generator ignores Markdown in comments

Open

#479 opened on Mar 9, 2015

View on GitHub
 (2 comments) (1 reaction) (0 assignees)HTML (5,474 forks)batch import
Client: HTMLEnhancement: Featurehelp wanted

Repository metrics

Stars
 (12,701 stars)
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. screen shot 2015-03-09 at 12 43 33 pm

Contributor guide

Research direction
Investigate the template used for static HTML generation to see how comments are processed and ensure Markdown is parsed before rendering.
Tech stack
html
Domain
documentation
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70