docs: mention about Nuxt integration

shikijs · Feb 16, 2024 · 87bcf73 · 87bcf73
1 parent e2a0a43
commit 87bcf73
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 13 deletions.
diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
@@ -34,6 +34,7 @@ const INTEGRATIONS: DefaultTheme.NavItemWithLink[] = [
   { text: 'Rehype', link: '/packages/rehype' },
   { text: 'Monaco Editor', link: '/packages/monaco' },
   { text: 'VitePress', link: '/packages/vitepress' },
+  { text: 'Nuxt', link: '/packages/nuxt' },
   { text: 'Astro', link: '/packages/astro' },
   { text: 'Common Transformers', link: '/packages/transformers' },
   { text: 'CLI', link: '/packages/cli' },

diff --git a/docs/guide/index.md b/docs/guide/index.md
@@ -33,19 +33,6 @@ Here is a little playground for you to try out how Shiki highlights your code. T
 
 [Install Shiki](/guide/install) to use it in your project.
 
-## Who is using?
-
-Projects that depend on Shiki (sorted alphabetically):
-
-- [Astro](https://docs.astro.build/en/guides/markdown-content/#syntax-highlighting)
-- [Expressive Code](https://expressive-code.com/)
-- [JSX email](https://jsx.email/)
-- [Lobe UI](https://github.com/lobehub/lobe-ui)
-- [Nuxt Content](https://content.nuxt.com/usage/markdown#code-highlighting)
-- [Slidev](https://sli.dev/custom/highlighters.html#highlighters)
-- [VitePress](https://vitepress.dev/guide/markdown#syntax-highlighting-in-code-blocks)
-- [Vocs](https://github.com/wevm/vocs)
-
 ## Bundle Size
 
 You can inspect the bundle size in detail on [pkg-size.dev/shiki](https://pkg-size.dev/shiki).

diff --git a/docs/packages/nuxt.md b/docs/packages/nuxt.md
@@ -0,0 +1,9 @@
+# Nuxt
+
+[Nuxt](https://nuxt.com) is a general-purpose meta-framework that gives you full control over your application. You can install Shiki along with integrations like ([markdown-it](/packages/markdown-it), [rehype](/packages/rehype)) or import manually as you needed.
+
+On top of that, Nuxt also provide some module integrations for Shiki allowing you use it easier:
+
+- [`nuxt-shiki`](https://github.com/pi0/nuxt-shiki) - Shiki integration for client and server sides, with component usage.
+- [`@nuxt/content`](https://github.com/nuxt/content) - Nuxt Content has Shiki built-in for markdown files. [You can enable it with the `highlight` option](https://content.nuxt.com/get-started/configuration#highlight).
+  - [`@nuxtjs/mdc`](https://github.com/nuxt-modules/mdc) - The underlying module of `@nuxt/content` that provides Markdown Component (MDC) syntax as well as Shiki for syntax highlighting.