# @comark/nuxt [](https://npmx.dev/@comark/nuxt) [](https://npm.chart.dev/@comark/nuxt) [](https://github.com/comarkdown/comark/actions/workflows/ci.yml) [](https://comark.dev/rendering/nuxt) [](https://github.com/comarkdown/comark/blob/main/LICENSE) Zero-config Nuxt module for [Comark](https://comark.dev), a high-performance markdown parser and renderer. ## Features - ⚡ Auto-imported `` and `` components (the old `` / `` names are still auto-registered but deprecated) - 📁 `~/components/prose` directory for overriding HTML elements - 🎨 Automatic [Nuxt UI](https://ui.nuxt.com) prose integration - 🖥️ SSR, SSG, and prerendering support out of the box - 🧩 Re-exports of Comark plugins (binding, math, mermaid) - 🎯 Full TypeScript support ## Installation ### Automatic Add `@comark/nuxt` to your project. This installs the dependency and registers the module in `nuxt.config.ts`: ```bash npx nuxt add comark ``` ### Manual Add `@comark/nuxt` to your dependencies: ```bash npm install @comark/nuxt # or pnpm add @comark/nuxt ``` Then add it to your `nuxt.config.ts`: ```ts export default defineNuxtConfig({ modules: ['@comark/nuxt'], }) ``` ## Usage The `` component is available globally, no imports needed. Pass markdown via the default slot or the `value` prop: ```vue ``` ### Custom components Map Comark tags to your own Vue components: ```vue ``` ```mdc ::alert{type="warning"} This is a warning. :: ``` ### Overriding HTML elements Drop components into `~/components/prose` to override how native HTML elements render. They are auto-registered: ``` ~/components/prose/ ProseH1.vue ProsePre.vue ProseA.vue ``` ### Plugins ```vue ``` ### Nuxt UI When [`@nuxt/ui`](https://ui.nuxt.com) is installed, prose components are wired up automatically: ```ts export default defineNuxtConfig({ modules: ['@comark/nuxt', '@nuxt/ui'], }) ``` ## Documentation Full guide and API reference at [comark.dev/rendering/nuxt](https://comark.dev/rendering/nuxt). ## Agent skill Coding agents can install the Comark skill from the docs site: ```bash npx skills add https://comark.dev ``` ## License Made with ❤️ Published under [MIT License](https://github.com/comarkdown/comark/blob/main/LICENSE).