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

All: Enable syntax highlighting in the docs? #1160

Open
bastelfreak opened this issue Jul 28, 2021 · 12 comments
Open

All: Enable syntax highlighting in the docs? #1160

bastelfreak opened this issue Jul 28, 2021 · 12 comments
Labels
triaged This ticket has been accepted to our backlog and migrated internally

Comments

@bastelfreak
Copy link

Describe the Change You Would Like

Hi! I was browsing through https://puppet.com/docs/bolt/latest/writing_tasks.html and I think the different code blocks are a bit hard to read. There are multiple different languages shown which makes it even more confusing. Would it be possible to use syntax highlighting for the code blocks?

@hestonhoffman
Copy link
Contributor

Hi! I agree! Syntax highlighting is on the roadmap for the Puppet docs website, but there are a couple of hurdles we have to clear before we get there. Hopefully, we'll get this implemented soon!

@github-actions
Copy link

This issue has not had activity for 60 days and will be marked as stale.
If this issue continues to have no activity for 7 days, it will be closed.

@bastelfreak
Copy link
Author

I really don't like the configuration of the bot

@github-actions
Copy link

This issue has not had activity for 60 days and will be marked as stale.
If this issue continues to have no activity for 7 days, it will be closed.

@igalic
Copy link

igalic commented Oct 3, 2022

I still don't see any colour anywhere.

@github-actions
Copy link

github-actions bot commented Dec 4, 2022

This issue has not had activity for 60 days and will be marked as stale.
If this issue continues to have no activity for 7 days, it will be closed.

@igalic
Copy link

igalic commented Dec 4, 2022

I still don't see any colour anywhere.

@bastelfreak
Copy link
Author

Hey people, it's 2024 and the code is still hard to read.

@davidsandilands
Copy link
Member

I've asked docs for an update to confirm plans. Since things have changed a lot since 2021 :-)

@davidsandilands davidsandilands transferred this issue from puppetlabs/bolt Jun 19, 2024
@davidsandilands
Copy link
Member

@bastelfreak as this will be possible to implement in the new flow documentation system perforce uses I have transferred this issue to puppet-docs

@lisarobertson lisarobertson added the triaged This ticket has been accepted to our backlog and migrated internally label Jun 25, 2024
Copy link

Migrated issue to PUPDOC-5664

@lisarobertson lisarobertson changed the title Enable syntax highlighting in the docs? All: Enable syntax highlighting in the docs? Sep 6, 2024
@bastelfreak
Copy link
Author

@davidsandilands do you know if there are any updates?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
triaged This ticket has been accepted to our backlog and migrated internally
Projects
None yet
Development

No branches or pull requests

5 participants