cobra icon indicating copy to clipboard operation
cobra copied to clipboard

Add Asciidoc documentation generator

Open craicoverflow opened this issue 3 years ago • 5 comments

This PR adds a documentation generator for Asciidoc.

craicoverflow avatar May 05 '21 09:05 craicoverflow

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.


Enda Phelan seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

CLAassistant avatar May 05 '21 09:05 CLAassistant

This PR is being marked as stale due to a long period of inactivity

github-actions[bot] avatar Jul 05 '21 00:07 github-actions[bot]

I don't have an opinion on how valuable such an improvement would be compared to the extra maintenance. I'll stil re-open until we can take an official stance on it.

Thanks @craicoverflow for your suggestion and contribution!

marckhouzam avatar Mar 28 '22 12:03 marckhouzam

I think it would help projects using tools like Antora to embed CLI docs easily. Right now I have to use pandoc to convert from Markdown to Asciidoc which makes the process a bit cumbersome.

Thanks @craicoverflow for great work! I hope it will be merged soon :)

bartoszmajsak avatar Aug 05 '22 11:08 bartoszmajsak

For anyone looking for a solution to having CLI documentation in Antora, I've recently done this by implementing an Antora extension. Have a look at this pull request. We use the YAML files as input and Handlebars templates to generate Asciidoc pages and place them in Antora catalog.

zregvart avatar Aug 08 '22 07:08 zregvart