Skip to content

Document switch from Prism to Shiki for syntax highlighting #777

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jun 3, 2025
Merged

Document switch from Prism to Shiki for syntax highlighting #777

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions code.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,7 @@ class HelloWorld {

## Syntax Highlighting

Put the name of your programming language after the three backticks to get syntax highlighting.

We use [Prism](https://prismjs.com/#supported-languages) for syntax highlighting. [Test Drive Prism](https://prismjs.com/test.html#language=markup) lists all the languages supported.
Enable syntax highlighting by adding the language name after the opening backticks of a code snippet.

```java
class HelloWorld {
Expand All @@ -62,6 +60,8 @@ class HelloWorld {
```
````

We use [Shiki](https://shiki.style/guide) for syntax highlighting and support all available [languages](https://shiki.style/languages).

## Names

Add a title after the programming language to set the name of your code example. The text can be anything as long as its all in one line.
Expand Down