tiptap/docs/installation.md

65 lines
1.8 KiB
Markdown
Raw Normal View History

---
tableOfContents: true
---
2021-02-08 23:41:57 +08:00
# Installation
## Introduction
2021-10-20 04:30:45 +08:00
tiptap is framework-agnostic and even works with Vanilla JavaScript (if thats your thing). The following integration guides help you integrating Tiptap in your JavaScript project.
## Integration guides
* [CDN](/installation/cdn)
2021-04-16 03:48:19 +08:00
* [React](/installation/react)
* [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)
* [Nuxt.js](/installation/nuxt)
2021-04-16 03:48:19 +08:00
* [Svelte](/installation/svelte)
* [Alpine.js](/installation/alpine)
* [Livewire](/installation/livewire) (Draft)
* [Angular](https://github.com/sibiraj-s/ngx-tiptap) (community package)
## Vanilla JavaScript
Youre using plain JavaScript or a framework thats not listed here? No worries, we provide everything you need.
### Requirements
* [Node](https://nodejs.org/en/download/) installed on your machine
### 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 doesnt include all, but the most common extensions.
```bash
# install with npm
npm install @tiptap/core @tiptap/starter-kit
# install with Yarn
yarn add @tiptap/core @tiptap/starter-kit
```
2021-02-08 23:41:57 +08:00
### 2. Add some markup
Add the following HTML where you want the editor to be mounted:
```html
<div class="element"></div>
```
### 3. Initialize the editor
Everything is in place now, so lets set up the actual editor now. Add the following code to your JavaScript:
```js
import { Editor } from '@tiptap/core'
2021-05-07 00:41:22 +08:00
import StarterKit from '@tiptap/starter-kit'
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-10-20 04:30:45 +08:00
Open your project in the browser to see Tiptap in action. Good work! Time to give yourself a pat on the back.