mirror/tiptap
1
0
Fork 0
mirror of https://github.com/ueberdosis/tiptap.git synced 2025-01-18 14:13:21 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

docs: a few minor tweaks to the installation guide

Browse Source
This commit is contained in:
hanspagel 2021-08-27 23:25:25 +02:00
parent 998e71b4e7
commit 195d79c9bb
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/src/docPages/installation.md
View File

@ -7,11 +7,10 @@ tableOfContents: true
## toc ## toc
## Introduction ## Introduction
tiptap is framework-agnostic and even works with Vanilla JavaScript, if that’s your thing. The following integration guides should help you to integrate tiptap in your JavaScript project. 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.
## Integration guides ## Integration guides
* [CDN](/installation/cdn) * [CDN](/installation/cdn)
<!-- * [CodeSandbox](/installation/codesandbox) -->
* [React](/installation/react) * [React](/installation/react)
* [Vue 3](/installation/vue3) * [Vue 3](/installation/vue3)
* [Vue 2](/installation/vue2) * [Vue 2](/installation/vue2)
@ -22,12 +21,13 @@ tiptap is framework-agnostic and even works with Vanilla JavaScript, if that’s
* [Angular](https://github.com/sibiraj-s/ngx-tiptap) (community package) * [Angular](https://github.com/sibiraj-s/ngx-tiptap) (community package)
## Vanilla JavaScript ## Vanilla JavaScript
You’re using plain JavaScript or a framework that’s not listed here? No worries, we provide everything you need.
### Requirements ### Requirements
* [Node](https://nodejs.org/en/download/) installed on your machine * [Node](https://nodejs.org/en/download/) installed on your machine
### 1. Install the dependencies ### 1. Install the dependencies
For the following example you will need `@tiptap/core` (the actual editor) and `@tiptap/starter-kit` which has the most common extensions to get started quickly. 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.
```bash ```bash
# install with npm # install with npm
@ -45,7 +45,7 @@ Add the following HTML where you want the editor to be mounted:
``` ```
### 3. Initialize the editor ### 3. Initialize the editor
Let’s initialize the editor in JavaScript now: Everything is in place now, so let’s set up the actual editor now. Add the following code to your JavaScript:
```js ```js
import { Editor } from '@tiptap/core' import { Editor } from '@tiptap/core'