Skip to content

Commit 8fd32fa

Browse files
chore: update readme
1 parent 859c0c6 commit 8fd32fa

File tree

1 file changed

+16
-5
lines changed

1 file changed

+16
-5
lines changed

README.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,12 @@
55
![Dependency](https://img.shields.io/packagist/dependency-v/bogdancondorachi/kirby-code-highlighter/php?style=for-the-badge&label=PHP&labelColor=3d444d&color=7C72FF)
66

77
> [!NOTE]
8-
> A server-side syntax highlighter plugin for Kirby CMS, powered by [Phiki](https://github.com/phikiphp/phiki), that uses TextMate grammars and VS Code themes to generate syntax-highlighted code within Kirby's code block and KirbyText.
8+
> A server-side syntax highlighter plugin for Kirby CMS, powered by [Phiki](https://github.com/phikiphp/phiki), that uses TextMate grammars and VS Code themes to generate syntax-highlighted code within Kirby's code block and KirbyText. Also with [Shiki](https://shiki.style) implementation for live code block preview inside the Kirby Panel!
99
1010
## ✨ Key Features
1111
-**Performance:** Fast and powerful syntax highlighting.
1212
- 🚀 **Integration:** Works with Kirby's code block and KirbyText.
13+
- 👁️ **Panel Preview:** Live code preview in the Kirby Panel.
1314
- 🌍 **Languages:** Over 200+ supported languages.
1415
- 🎨 **Themes:** Choose from 50+ VS Code themes.
1516
- 🔐 **Base64 Support:** Handles base64-encoded content.
@@ -66,13 +67,23 @@ Set the default theme:
6667
6768
```php
6869
'bogdancondorachi.code-highlighter' => [
69-
'theme' => 'github-dark-dimmed',
70+
'theme' => 'github-dark-default',
7071
],
7172
```
7273
*Check out the [supported](#explore-supported-languages-and-themes) themes*
7374
75+
### Default Language
76+
Set the default language:
77+
78+
```php
79+
'bogdancondorachi.code-highlighter' => [
80+
'language' => 'text',
81+
],
82+
```
83+
*Check out the [supported](#explore-supported-languages-and-themes) languages*
84+
7485
### Light/Dark Dual Themes
75-
If you use light/dark mode on your website, you can set a default theme each individual mode:
86+
If you use light/dark mode on your website, you can set a default theme for each individual mode:
7687
7788
```php
7889
'bogdancondorachi.code-highlighter' => [
@@ -136,12 +147,12 @@ Customize the languages and themes options available in Kirby’s code block:
136147
'block.languages' => [
137148
'css' => 'CSS',
138149
'php' => 'PHP',
139-
'js' => 'JavaScript',
150+
'yml' => 'Yaml',
140151
],
141152
'block.themes' => [
142153
'github-dark' => 'GitHub Dark',
143154
'github-light' => 'GitHub Light',
144-
'plastic' => 'Plastic',
155+
'vitesse-dark' => 'Vitesse Dark',
145156
],
146157
],
147158
```

0 commit comments

Comments
 (0)