Skip to content
This repository has been archived by the owner on Mar 9, 2022. It is now read-only.

Update CodeBlock syntax #375

Merged
merged 1 commit into from
Jan 12, 2022
Merged

Update CodeBlock syntax #375

merged 1 commit into from
Jan 12, 2022

Conversation

amyrlam
Copy link
Contributor

@amyrlam amyrlam commented Jan 12, 2022

📌 Summary

Allows us to write code samples as they are, improving code readability

🔗 External Links

Follow-on to ember-prism example #367


💬 Please consider using conventional comments when reviewing this PR.

Allows us to write code samples as they are, improving code readability
@vercel
Copy link

vercel bot commented Jan 12, 2022

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/hashicorp/flight/FjRZCmvekxwYwn5r8yssQs32CNUX
✅ Preview: https://flight-git-amy-update-ember-prism-hashicorp.vercel.app

Copy link
Contributor

@didoo didoo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK for me

Copy link
Contributor

@MelSumner MelSumner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This makes me uneasy but if you and @didoo are okay with it then I have no blockers.

@didoo
Copy link
Contributor

didoo commented Jan 12, 2022

@MelSumner I agree is not ideal, but of the possible different ways to do it using ember-prism this is the least worst (fully escaping the strings is a no-no for me).

A few days ago I have looked into possible other syntax highlighters, and I could not find one that could support snippets of code directly in the handlebars code. If you have alternatives happy to discuss.

@amyrlam
Copy link
Contributor Author

amyrlam commented Jan 12, 2022

What makes you uneasy?

We can explore the code in .js option (or snippet of some sort) https://github.com/hashicorp/design-system-components/issues/128, but if we want an "edit on GitHub" button on the website, the code block won't be a part of the same file.

Feel free to add more detail to that issue or file another one if a better solution?

@amyrlam amyrlam merged commit 0d43287 into main Jan 12, 2022
@amyrlam amyrlam deleted the amy/update-ember-prism branch January 12, 2022 16:02
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants