Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
craigbox opened this issue May 2, 2024 · 3 comments

Comments

@craigbox
Copy link
Contributor

craigbox commented May 2, 2024

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
Copy link
Contributor Author

craigbox commented May 7, 2024

@howardjohn
Copy link
Member

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

@mikemorris
Copy link
Member

mikemorris commented Jul 17, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants