Skip to content

Commit 2bae447

Browse files
axmmisakalhstrh
andauthored
Update docs/developer/website-development.mdx
Co-authored-by: Marten Lohstroh <[email protected]>
1 parent 14841a2 commit 2bae447

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/developer/website-development.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ For languages other than Lingua Franca, highlighting is handled by Prism, which
3737

3838
For Lingua Franca, highlighting is handled by [Shiki](https://github.com/shikijs/shiki). This is mainly because we only have TextMate grammar definition and it is not easy to convert from it to Prism.
3939

40-
Like Prism, we are running Shiki in browser and the code is updated in browser by React after it is highlighted. Shiki has a relatively large footprint, so its not necessarily encourage to run in browsers. Yet running it in browser might help SEO and makes maintenance easier.
40+
Like Prism, we are running Shiki in browser and the code is updated in browser by React after it is highlighted. Shiki has a relatively large footprint, so its not necessarily encouraged to run in browsers. Yet running it in browser might help SEO and makes maintenance easier.
4141

4242
The component we created is `ShikiLFHighlighter` in `src/components/ShikiLFHighlighter/index.tsx`. As Shiki highlights code asynchorously, the component will display the unhighlighted code first (for a very short period of time), and asynchronously update the HTML to be the one with highlighted code with React. This will not hurt SEO as the highlight will not be considered by search engines.
4343

0 commit comments

Comments
 (0)