\n Instantly add TipTap Editor with basic functionality to your Nuxt 3 App.\n
\n\n
\n \n
\n\n---\n\n- 📖 [Documentation for Module](https://nuxt-tiptap-editor.vercel.app) | [Documentation by Tiptap](https://tiptap.dev/docs/editor/extensions/overview)\n- ✨ [Release Notes](/CHANGELOG.md)\n- 🏀 [Online playground](https://stackblitz.com/github/modbender/nuxt-tiptap-editor?file=playground%2Fapp.vue)\n\n\n## Quick Setup\n\n1. Add `nuxt-tiptap-editor` dependency to your project\n\n ```sh\n npx nuxi@latest module add tiptap\n ```\n\n2. Add `nuxt-tiptap-editor` to the `modules` section of `nuxt.config.ts`\n\n ```js\n export default defineNuxtConfig({\n modules: ['nuxt-tiptap-editor'],\n tiptap: {\n prefix: 'Tiptap', //prefix for Tiptap imports, composables not included\n },\n });\n ```\n\n3. You can use the contents of this file as reference. \n Copy the code to your own `components/TiptapEditor.vue`. \n Any path is fine as long as it's under `components` directory with `.vue` extension.\n\n ```vue\n \n
\n \n\n \n ```\n\n4. Now edit the HTML, replace `button` with your UI provided component, or style it using tailwind or whichever CSS you are using, add icons or text, modify active state class, verify dark mode, etc.\n\nThat's it! You can now use Nuxt TipTap Editor in your Nuxt app ✨\n\n## Development\n\nThis repo uses **pnpm** as the package manager.\n\n```bash\n# Install dependencies\npnpm install\n\n# Generate type stubs (must be run after install and after structural changes in src/)\npnpm dev:prepare\n\n# Develop with the playground\npnpm dev\n\n# Build the playground\npnpm build\n\n# Run ESLint\npnpm lint\n\n# Run Vitest (also runs vue-tsc --noEmit)\npnpm test\npnpm test:watch\n```\n\n### Releasing\n\nUse the version-bump scripts (they trigger CI publish via OIDC):\n\n```bash\npnpm release:patch # 3.2.x → 3.2.(x+1)\npnpm release:minor # 3.2.x → 3.3.0\npnpm release:major # 3.x.y → 4.0.0\n```\n\nSee [RELEASE.md](./RELEASE.md) for details.\n\n### Upgrading TipTap or Nuxt\n\nAfter bumping a major dependency, run the full suite — `pnpm test` and `pnpm test:types` will catch:\n- removed/renamed module APIs (registration tests)\n- broken extension behavior (command tests)\n- broken auto-import wiring (registration tests + smoke tests)\n- broken lowlight head-link injection\n\nThings the test suite cannot catch — please verify manually in `pnpm dev`:\n- BubbleMenu / FloatingMenu rendering and positioning\n- Drag/drop and paste flows in `playground/components/TipTapImage.vue`\n- Visual / CSS regressions\n\n## Contribution\n\nFeel free to send out any valid pull requests. Would love to get any help!\n\n\n\n[npm-version-src]: https://img.shields.io/npm/v/nuxt-tiptap-editor/latest.svg?style=flat&colorA=18181B&colorB=28CF8D\n[npm-version-href]: https://npmjs.com/package/nuxt-tiptap-editor\n[npm-downloads-src]: https://img.shields.io/npm/dm/nuxt-tiptap-editor.svg?style=flat&colorA=18181B&colorB=28CF8D\n[npm-downloads-href]: https://npmjs.com/package/nuxt-tiptap-editor\n[license-src]: https://img.shields.io/npm/l/nuxt-tiptap-editor.svg?style=flat&colorA=18181B&colorB=28CF8D\n[license-href]: https://npmjs.com/package/nuxt-tiptap-editor\n[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js\n[nuxt-href]: https://nuxt.com\n","readmeFilename":"README.md"}
![\"npm](\"https://img.shields.io/npm/v/nuxt-tiptap-editor/latest.svg?style=flat&colorA=18181B&colorB=28CF8D\")
\n \n ![\"npm](\"https://img.shields.io/npm/dm/nuxt-tiptap-editor.svg?style=flat&colorA=18181B&colorB=28CF8D\")
\n \n ![\"License\"](\"https://img.shields.io/npm/l/nuxt-tiptap-editor.svg?style=flat&colorA=18181B&colorB=28CF8D\")
\n \n ![\"Nuxt\"](\"https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js\"){kind=icon}
\n \n![\"Tiptap](\"https://assets-global.website-files.com/645a9acecda2e0594fac6126/65675de8c3c9cffc1a4a4d26_editor-eaxmple-placeholder-p-800.png\")
\n