search

cue-lang / cue

The home of the CUE language! Validate and define text-based and dynamic configuration
https://cuelang.org
Apache License 2.0
5.12k stars 293 forks source link

preprocessor: {{{with sidetrack}}} is used by the language guide, but does not exist #2549

Open jpluscplusm opened 1 year ago

jpluscplusm commented 1 year ago

In sources such as https://github.com/cue-lang/cuelang.org/blob/alpha/content/docs/language-guide/templating/references/en.md?plain=1#L12 we have the preprocessor directive {{{with sidetrack}}}.

This directive is currently rendered as normal text (i.e. isn't intercepted by the preprocessor), and isn't mentioned in any other issue - hence this issue.

myitcv commented 1 year ago

What should this render as in the situations you have used it?

jpluscplusm commented 1 year ago

What should this render as in the situations you have used it?

I haven't used it, I merely found it in existing alpha content.

So if the author intended it to mean something, visually, we either need to support it, or remove the {{{with sidetrack}}} .

My reading of the content in the specific example I referenced suggests to me that it's intended as some kind of side note, but with longer content than https://alpha.cuelang.org/examples/shortcodes/sidenote/ can cope with. I don't think it's an {{<info>}}, either, and a footnote seems incorrect as well.