swagger-api/swagger-codegen

Static HTML generator ignores Markdown in comments

Open

#479 建立於 2015年3月9日

在 GitHub 查看
 (2 留言) (1 反應) (0 負責人)HTML (12,701 star) (5,474 fork)batch import
Client: HTMLEnhancement: Featurehelp wanted

描述

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

貢獻者指南

技術棧
html
領域
documentation
議題類型
bug
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Basic Markdown syntaxSwagger/OpenAPI spec knowledgeTemplate engine concepts
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
40
研究方向
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.