question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

[REQ] Add AsciiDoc as an option for client library documentation

See original GitHub issue

Is your feature request related to a problem? Please describe.

We would like to generate SDK libraries, as well as a documentation website with the use of this generator. We would also like to use Antora to generate a documentation website. Antora however generates pages based on Asciidoc files, not markdown. The SDKs that are generated typically only use markdown for their documentation. I would like to be able to choose between Markdown or Asciidoc for the SDK documentation library.

Describe the solution you’d like

When I generate a Client SDK library, I would like to have a command line option that allows be to choose the language that the documentation will be generated in, such as [--documentation-lang <documentation-lang>]

Our primary interest is AsciiDoc, however if this option is present then it also opens up the ability to use other languages as well.

Some potential usages: openapi-generator generate -i petstore.yaml -g java --documentation-lang asciidoc -o /tmp/test/ openapi-generator generate -i petstore.yaml -g java --documentation-lang html -o /tmp/test/ openapi-generator generate -i petstore.yaml -g java --documentation-lang pdf -o /tmp/test/ openapi-generator generate -i petstore.yaml -g java --documentation-lang latex -o /tmp/test/

Describe alternatives you’ve considered

We have experimented with simply converting the already generated markdown documentation into asciidoc, however this carries it’s own set of issues as most of the generated documentation uses tables, which are not officially supported in the markdown specification, and thus don’t always convert properly into asciidoc.

Additional context

No additional context that I can think of.

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Comments:10 (9 by maintainers)

github_iconTop GitHub Comments

1reaction
wing328commented, Mar 8, 2021

@tballast your submission is not late and we appreciate your contributions to improve the project. Have a good day.

0reactions
tballastcommented, Mar 8, 2021

@wing328 thanks for the help. Sorry for the late submission, I was unavailable on the weekend.

Read more comments on GitHub >

github_iconTop Results From Across the Web

AsciiDoc User Guide
AsciiDoc is a text document format for writing notes, documentation, articles, books, ebooks, slideshows, web pages, blogs and UNIX man ...
Read more >
AsciiDoc Writer's Guide | Asciidoctor
This guide describes the basic structure of an AsciiDoc document, how to create your ... To present the items in reverse order, add...
Read more >
AsciiDoc - GitLab Docs
GitLab uses the Asciidoctor gem to convert AsciiDoc content to HTML5. Consult the Asciidoctor User Manual for a complete Asciidoctor reference.
Read more >
AsciiDoc reference - Product documentation
AsciiDoc is a lightweight markup language, similar to Markdown. ... When you add [horizontal] above item 1, the label and description appear ...
Read more >
asciidoctor/asciidoclet: A Javadoc Doclet based on ... - GitHub
Overview documentation can be generated from an Asciidoc file using the standard -overview option. Files matching *.adoc , *.ad , *.asciidoc or *.txt...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found