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

Switch to prism syntax highlighting for website #1572

Merged
merged 1 commit into from
Mar 28, 2022
Merged

Switch to prism syntax highlighting for website #1572

merged 1 commit into from
Mar 28, 2022

Conversation

rothgar
Copy link
Contributor

@rothgar rothgar commented Mar 24, 2022

1. Issue, if available:

2. Description of changes:
Switch hugo theme code blocks to render with prism so code blocks have a copy button

3. How was this change tested?
It was not tested locally but I can verify it with the PR site provided by opening this PR.

I should mention the docs for it are here https://www.docsy.dev/docs/adding-content/lookandfeel/#code-highlighting-with-prism

4. Does this change impact docs?

  • [ x ] Yes, PR includes docs updates
  • Yes, issue opened: link to issue
  • No

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@netlify
Copy link

netlify bot commented Mar 24, 2022

Deploy Preview for karpenter-docs-prod ready!

Name Link
🔨 Latest commit 7a7b8cc
🔍 Latest deploy log https://app.netlify.com/sites/karpenter-docs-prod/deploys/623ce7d507cfdb0008dcdd05
😎 Deploy Preview https://deploy-preview-1572--karpenter-docs-prod.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@spring1843
Copy link
Contributor

Screen Shot 2022-03-24 at 4 17 15 PM

The color coding sometimes doesn't make sense, look at this example where open is colored red in both lines while in one it's an executable binary and in the other a parameter.

@bwagner5 bwagner5 merged commit b141f99 into aws:main Mar 28, 2022
@rothgar
Copy link
Contributor Author

rothgar commented Mar 28, 2022

That's interesting on the color differences. There are a few other tweaks we can play with in the config to try and make it consistent. We could also try bringing in some of the optional language support https://prismjs.com/download.html#themes=prism

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

Successfully merging this pull request may close these issues.

4 participants