api icon indicating copy to clipboard operation
api copied to clipboard

Angle brackets are converted to HTML entities rather than passed through for shortcodes

Open craigbox opened this issue 1 year ago • 3 comments

https://github.com/istio/api/blob/master/security/v1/peer_authentication.proto:

// {{< warning >}}
// Development of PeerAuthentication is currently frozen and likely to be replaced in Ambient.
// {{< /warning >}}

https://github.com/istio/api/blob/master/security/v1beta1/peer_authentication.pb.html:

<p>{{&lt; warning &gt;}}
Development of PeerAuthentication is currently frozen and likely to be replaced in Ambient.
{{&lt; /warning &gt;}}

The shortcodes don't work on the site as a result.

Screenshot 2024-05-02 at 2 25 02 PM

Can we change the parsing, or should we remove the shortcodes?

craigbox avatar May 02 '24 02:05 craigbox

I think we have our own at https://github.com/istio/tools/tree/master/cmd/protoc-gen-docs which ultimately plumbs out to https://github.com/yuin/goldmark

howardjohn avatar May 07 '24 23:05 howardjohn

Not relevant to this specific example anymore as the warning is being removed in https://github.com/istio/istio.io/pull/15434, but did we try using the triple mustache {{{ }}} to disable auto-escaping?

mikemorris avatar Jul 17 '24 19:07 mikemorris