OpenAPITools / OpenAPITools/openapi-generator
[REQ] Asciidoc generator should also convert markdown into asciidoc
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Is your feature request related to a problem? Please describe.
In openapi you can write rich text in element descriptions with the markdown syntax. See https://swagger.io/docs/specification/2-0/basic-structure/
You I now use the asciidoc generator I get files mixed with asciidoc and markdown.
Describe the solution you'd like
All markdown rich text should be converted into asciidoc.
Describe alternatives you've considered
❌
Additional context
There is a library that can convert markdown into asciidoc. See https://github.com/bodiam/markdown-to-asciidoc
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the Asciidoc generator entry point and review the markdown-to-asciidoc library linked in the issue. Trace where OpenAPI element descriptions are emitted, then verify that markdown rich text is consistently converted to Asciidoc rather than copied unchanged.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, markdown
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100