Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Asciidoc documentation generator #1390

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

craicoverflow
Copy link

This PR adds a documentation generator for Asciidoc.

@CLAassistant
Copy link

CLAassistant commented May 5, 2021

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.

@github-actions github-actions bot added the area/docs-generation Generation of docs via Cobra label May 5, 2021
@github-actions
Copy link

github-actions bot commented Jul 5, 2021

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

@marckhouzam
Copy link
Collaborator

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 marckhouzam reopened this Mar 28, 2022
@marckhouzam marckhouzam added kind/feature A feature request for cobra; new or enhanced behavior and removed kind/stale labels Mar 28, 2022
@bartoszmajsak
Copy link

bartoszmajsak commented Aug 5, 2022

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 :)

@zregvart
Copy link
Contributor

zregvart commented Aug 8, 2022

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.

hoshsadiq pushed a commit to zulucmd/zulu that referenced this pull request Dec 31, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs-generation Generation of docs via Cobra kind/feature A feature request for cobra; new or enhanced behavior
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants