search

ahmetb / gen-crd-api-reference-docs

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

Add support for Markdown compatible anchors #54

Closed aminesnow closed 1 year ago

aminesnow commented 1 year ago

Context: We are using this awesome tool to generate our API docs, however, we rely on other tools that work with the Markdown format. This PR adds some functions that make it possible to use Markdown friendly anchors. It also updates to using Go 1.18.

ahmetb commented 1 year ago

This generates HTML with IDs. are those not compatible with markdown?

aminesnow commented 1 year ago

This generates HTML with IDs. are those not compatible with markdown?

Hey @ahmetb ! In our case no, since we use a tool that detects only Markdown headers. So I changed the template to use them, but then the headers' anchors were no longer viable.