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

Colored Syntax Highlghing in Readme code blocks #606

Closed
TheDudeFromCI opened this issue Jun 8, 2020 · 5 comments
Closed

Colored Syntax Highlghing in Readme code blocks #606

TheDudeFromCI opened this issue Jun 8, 2020 · 5 comments

Comments

@TheDudeFromCI
Copy link
Contributor

Really small feature, but it would be nice to have.

Some packages write their API usage in their Readme files in code blocks. Some syntax highlighting on the website might make this a bit easier to read.

@issue-label-bot
Copy link

Issue-Label Bot is automatically applying the label feature_request to this issue, with a confidence of 0.97. Please mark this comment with 👍 or 👎 to give our bot feedback!

Links: app homepage, dashboard and code for this bot.

@favoyang
Copy link
Member

favoyang commented Jun 8, 2020

A nice to have feature. Do you have one or two example pages (with code blocks)?

@TheDudeFromCI
Copy link
Contributor Author

@favoyang
Copy link
Member

favoyang commented Jun 8, 2020

Quick-n-dirty notes,

Vuepress uses markdown-it as the markdown renderer, and prismjs to handle the syntax. This thread discussed how it works.

OpenUPM uses marked to render README markdown. (Can not remember why not just use markdown-it directly, maybe an API reason). With highlight.js together to support syntax highlighting or maybe just keyword highlighting?

github-actions bot pushed a commit that referenced this issue Jun 8, 2020
# [1.30.0](1.29.1...1.30.0) (2020-06-08)

### Features

* **website:** code highlighting of package README (close: [#606](#606)) ([dcdb95b](dcdb95b))
@github-actions
Copy link

github-actions bot commented Jun 8, 2020

🎉 This issue has been resolved in version 1.30.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants