gen-crd-api-reference-docs icon indicating copy to clipboard operation
gen-crd-api-reference-docs copied to clipboard

Option and code to generate AsciiDoc friendly output

Open djencks opened this issue 2 years ago • 4 comments

See https://github.com/ahmetb/gen-crd-api-reference-docs/issues/44

This does not currently include the two sets of AsciiDoc templates, as I'm not sure where they should go.

As noted in the issue, there is likely a better way to switch between text/Template and html/Template.

This is what I'm using for generating the Camel-K docs, and it's WIP, not a final proposal.

djencks avatar Jan 30 '22 04:01 djencks

Hi @ahmetb, this is important for us. Is there anything else we can do to get it merged?

tadayosi avatar Jul 11 '22 07:07 tadayosi

I am confused about the contents in the change.

It offers an asciidoc config option but there's no asciidoc related code.

Is this simply "disable markdown rendering"?

I am not willing to support AsciiDoc if it warrants a separate template. Many projects use md/html (see README) and this can become too much hassle to support properly.

Feel free to fork this tool as you see fit. I maintain this at a personal capacity anyway.

ahmetb avatar Jul 11 '22 19:07 ahmetb

@djencks is the source available for the version that you forked for the Camel-K docs? I'm interested in trying this tool out for our project.

JakeSCahill avatar Jun 16 '23 16:06 JakeSCahill

@JakeSCahill Sure, the appropriate branch in my fork is https://github.com/djencks/gen-crd-api-reference-docs/tree/main-asciidoc. I haven't updated it lately, and it appears to be behind the original project. I haven't looked to see if I should merge in the updates. Discussing that on my fork would be more appropriate than here.

djencks avatar Jun 16 '23 20:06 djencks