ahmetb / gen-crd-api-reference-docs

API Reference Docs generator for Kubernetes CRDs (used by Knative, Kubeflow and others)
Apache License 2.0
306 stars 99 forks source link

Option to generate AsciiDoc output #44

Open djencks opened 2 years ago

djencks commented 2 years ago

For Apache Camel-K I've modified this project, adding an option to generate AsciiDoc output rather than html. The current results can be seen here:

https://camel.apache.org/camel-k/next/apis/camel-k.html https://camel.apache.org/camel-k/next/apis/kamelets.html

The code modifications are:

I also have two sets of templates:

If there's interest in bringing these capabilities into the project, I'd like to start discussing what would be needed to do so. In particular...

Note that https://github.com/ahmetb/gen-crd-api-reference-docs/pull/11 includes a separate function that can be called from a template that also produces more AsciiDoc-friendly IDs.