2021-08-24 17:24:10 +08:00
---
tableOfContents: true
---
2021-02-08 23:41:57 +08:00
# Installation
2021-02-07 22:55:50 +08:00
## Introduction
2022-01-28 06:04:05 +08:00
Tiptap is framework-agnostic and even works with Vanilla JavaScript (if that’ s your thing). The following integration guides help you integrating Tiptap in your JavaScript project.
2021-02-07 22:55:50 +08:00
## Integration guides
2022-01-28 06:04:05 +08:00
<!-- * [CDN ](/installation/cdn ) -->
2021-04-16 03:48:19 +08:00
* [React ](/installation/react )
2021-10-07 19:15:45 +08:00
* [Next.js ](/installation/nextjs )
2021-03-04 04:35:47 +08:00
* [Vue 3 ](/installation/vue3 )
2021-04-16 03:48:19 +08:00
* [Vue 2 ](/installation/vue2 )
2021-02-07 22:55:50 +08:00
* [Nuxt.js ](/installation/nuxt )
2021-04-16 03:48:19 +08:00
* [Svelte ](/installation/svelte )
* [Alpine.js ](/installation/alpine )
2022-01-28 06:04:05 +08:00
* [PHP ](/installation/php )
2021-02-07 22:55:50 +08:00
2021-10-29 23:48:50 +08:00
### Community efforts
* [Angular ](https://github.com/sibiraj-s/ngx-tiptap )
* [SolidJS ](https://github.com/LXSMNSYC/solid-tiptap )
2021-02-07 22:55:50 +08:00
2021-10-29 23:48:50 +08:00
## Vanilla JavaScript
You are using plain JavaScript or a framework that is not listed here? No worries, we provide everything you need.
2021-02-07 22:55:50 +08:00
### 1. Install the dependencies
2021-08-28 05:49:22 +08:00
For the following example you will need `@tiptap/core` (the actual editor) and `@tiptap/starter-kit` .
The StarterKit doesn’ t include all, but the most common extensions.
2021-02-07 22:55:50 +08:00
```bash
npm install @tiptap/core @tiptap/starter -kit
```
2021-02-08 23:41:57 +08:00
### 2. Add some markup
2021-02-07 22:55:50 +08:00
Add the following HTML where you want the editor to be mounted:
```html
< div class = "element" > < / div >
```
### 3. Initialize the editor
2021-08-28 05:25:25 +08:00
Everything is in place now, so let’ s set up the actual editor now. Add the following code to your JavaScript:
2021-02-07 22:55:50 +08:00
```js
import { Editor } from '@tiptap/core'
2021-05-07 00:41:22 +08:00
import StarterKit from '@tiptap/starter-kit'
2021-02-07 22:55:50 +08:00
new Editor({
element: document.querySelector('.element'),
2021-05-07 00:41:22 +08:00
extensions: [
StarterKit,
],
2021-04-03 23:30:56 +08:00
content: '< p > Hello World!< / p > ',
2021-02-07 22:55:50 +08:00
})
```
2021-10-29 23:48:50 +08:00
Open your project in the browser to see Tiptap in action. Good work!