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

Syntax highlighting of examples #1701

Closed
danielpeintner opened this issue Sep 29, 2022 · 1 comment · Fixed by #1711
Closed

Syntax highlighting of examples #1701

danielpeintner opened this issue Sep 29, 2022 · 1 comment · Fixed by #1711
Labels
Editorial Issues with no technical impact on implementations PR available

Comments

@danielpeintner
Copy link
Contributor

I looked into the reason why some examples are not properly rendered with Syntax highlighting, e.g.,

ReSpec uses highlight.js for syntax highlighting (see https://respec.org/docs/#pre-and-code-elements).

Unfortunately highlight.js it does not seem to support code snippets with "..."

To solve this we could simply use comments like // or /* */ to make it work.... Would that be okay for everybody?

see below Example5 and Example6 and how it may look like

grafik

grafik

@github-actions github-actions bot added the needs-triage Automatically added to new issues. TF should triage them with proper labels label Sep 29, 2022
@egekorkan egekorkan added Editorial Issues with no technical impact on implementations and removed needs-triage Automatically added to new issues. TF should triage them with proper labels labels Sep 29, 2022
@egekorkan
Copy link
Contributor

I think this is definitely much nicer! Also from markdown, I generally pick js as the language and then use the // type of comments. Not sure how the behavior changes here though

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Editorial Issues with no technical impact on implementations PR available
Projects
None yet
3 participants