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 (12,701 stars) (5,474 forks)batch import
Client: HTMLEnhancement: Featurehelp wanted

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

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.
3
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic Markdown syntaxSwagger/OpenAPI spec knowledgeTemplate engine concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Investigate the static HTML generation code in the swagger codegen repository. Look at how comments are processed and rendered in the HTML templates. Check if Markdown parsing is applied consistently, comparing with the swagger editor's rendering. The issue may lie in the template engine or Markdown conversion library used. Review existing comments in the issue for any hints and examine the code for the static HTML generator.
Static HTML generator ignores Markdown in comments · swagger-api/swagger-codegen#479 | Good First Issue