Skip to content

Commit 0ef9dde

Browse files
authored
chore: typos in Highlighters documentation (#162)
1 parent 145fc07 commit 0ef9dde

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

custom/highlighters.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Highlighters
22

3-
Slidev comes with two syntax highlighter for you to choose from:
3+
Slidev comes with three syntax highlighters for you to choose from:
44

55
- [Prism](https://prismjs.com/)
66
- [Shiki](https://github.com/shikijs/shiki)
@@ -10,7 +10,7 @@ Slidev comes with two syntax highlighter for you to choose from:
1010

1111
**Shiki**, on the other hand, is a TextMate grammar-powered syntax highlighter. It generates colored tokens, so there is no additional CSS needed. Since it has great grammar support, the generated colors are very accurate, just like what you will see in VS Code. Shiki also comes with [a bunch of built-in themes](https://github.com/shikijs/shiki/blob/master/docs/themes.md). The downside of Shiki is that it also requires TextMate themes (compatible with VS Code theme) to do the highlighting, which can be a bit harder to customize.
1212

13-
**Shikiji** is a ESM rewrite of Shiki bringing many improvements and new features. You could have [AST-based transformers](https://github.com/antfu/shikiji#hast-transformers) to customize how the code is rendered. And the [TwoSlash](#twoslash) support is also built-in.
13+
**Shikiji** is an ESM rewrite of Shiki bringing many improvements and new features. You could have [AST-based transformers](https://github.com/antfu/shikiji#hast-transformers) to customize how the code is rendered. And the [TwoSlash](#twoslash) support is also built-in.
1414

1515
Slidev themes usually support both Prism and Shiki, but depending on the theme you are using, it might only support one of them.
1616

@@ -32,7 +32,7 @@ highlighter: shikiji
3232

3333
This feature is only available when you set `highlighter` to `shikiji`.
3434

35-
[TwoSlash](https://www.typescriptlang.org/dev/twoslash/) is a powerful tool for rendering TypeScript code blocks with type informations on hover or inlined. It's quite useful for preapring slides for JavaScript/TypeScript related topics.
35+
[TwoSlash](https://www.typescriptlang.org/dev/twoslash/) is a powerful tool for rendering TypeScript code blocks with type information on hover or inlined. It's quite useful for preparing slides for JavaScript/TypeScript-related topics.
3636

3737
To use it, you can add `twoslash` to the code block's language identifier:
3838

@@ -42,11 +42,11 @@ console.log('hello')
4242
```
4343
~~~
4444

45-
And example of TwoSlash enabled code snippet [can be found here](https://antfu.me/posts/shikiji-twoslash).
45+
An example of TwoSlash enabled code snippet [can be found here](https://antfu.me/posts/shikiji-twoslash).
4646

4747
## Configure Prism
4848

49-
To configure your Prism, you can just import the theme css or use [`prism-theme-vars`](https://github.com/antfu/prism-theme-vars) to configure themes for both light and dark mode. Refer to its docs for more details.
49+
To configure your Prism, you can just import the theme CSS or use [`prism-theme-vars`](https://github.com/antfu/prism-theme-vars) to configure themes for both light and dark mode. Refer to its docs for more details.
5050

5151
## Configure Shiki
5252

@@ -112,4 +112,4 @@ export default defineShikijiSetup(() => {
112112

113113
Refer to [Shikiji's docs](https://github.com/antfu/shikiji) for all available options.
114114

115-
> It make it easier for the community to adapt, when no `shikiji.ts` it presented, we will look for `shiki.ts` and try to convert it to Shikiji options.
115+
> It makes it easier for the community to adapt, when no `shikiji.ts` is presented, we will look for `shiki.ts` and try to convert it to Shikiji options.

0 commit comments

Comments
 (0)