elastic / crd-ref-docs

Generates Kubernetes CRD API reference documentation
Apache License 2.0
104 stars 54 forks source link

Minor markdown improvements #91

Open olensmar opened 3 months ago

olensmar commented 3 months ago

This fixes three issues I bumped into when trying to generate our docs:

1) adds version to generated file names in group-mode - to avoid files overwriting each-other 2) escapes html-tags in descriptions 3) escapes curly-braces in link labels for mdx (docusaurus) compatibility

I'm in no way a go programmer so I apologize in advance if I haven't solved these problems in the correct way and/or made some newbie mistakes.. happy to learn and adjust from you reviewers!

cla-checker-service[bot] commented 3 months ago

💚 CLA has been signed

olensmar commented 3 months ago

sorry - i've signed the CLA now..