swagger-api / swagger-api/swagger-codegen

~~~ block does not work in HTML codegen

Open
#2,807 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Client: HTML Feature: Documentation help wanted Issue: Bug
Dominant language
Mustache
Stars
17.8k
Forks
6k
PR merge metrics
No merged PRs in 30d

Description

My description contains a ~~~ block that renders fine in the swagger editor. When I use the code gen command with HTML as the target language no code block is being created but the ~~~ are displayed in the text. Furthermore all the line breaks are shown as \n.
I'm using http://repo1.maven.org/maven2/io/swagger/swagger-codegen-cli/2.1.6/swagger-codegen-cli-2.1.6.jar

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the issue with swagger-codegen-cli-2.1.6.jar using HTML as the target and a description containing a ~~~ block. Compare the generated HTML with the Swagger Editor rendering, focusing on the displayed delimiters and literal line breaks. Done means the HTML output renders the description as a code block with normal line breaks.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.