swagger-api/swagger-codegen

Static HTML generator ignores Markdown in comments

Open

#479 opened on 2015年3月9日

GitHub で見る
 (2 comments) (1 reaction) (0 assignees)HTML (12,701 stars) (5,474 forks)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
Issue 種別
bug
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.