mirror/tiptap
1
0
Fork 0
mirror of https://github.com/ueberdosis/tiptap.git synced 2024-11-25 12:39:03 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

improve getting started

Browse Source
This commit is contained in:
Hans Pagel 2020-08-13 10:27:56 +02:00
parent f1f05cb48a
commit eaac0101eb
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/src/docPages/getting-started.md
View File

@ -2,21 +2,21 @@
tiptap is framework-agnostic and works with Vue.js and React. It even works with plain JavaScript, if that’s your thing. To keep everything as small as possible, we put the code to use tiptap with those frameworks in different packages.
## Use tiptap with Vue.js
## 1. Install the dependencies
We assume you already have a Vue.js (or Nuxt.js) project. To use tiptap in that project, you are going to need the tiptap Vue.js adapter. You can install tiptap for Vue.js as a dependency in your project:
We assume you already have a [Vue.js](https://cli.vuejs.org/) (or [Nuxt.js](https://nuxtjs.org/)) project. To connect tiptap with Vue.js you are going to need an adapter. You can install tiptap for Vue.js as a dependency in your project:
```bash
# Install Vue.js adapter with npm
npm install @tiptap/vue @tiptap/vue-starter-kit
# Install Vue.js adapter with Yarn
# Or: Install Vue.js adapter with Yarn
yarn add @tiptap/vue @tiptap/vue-starter-kit
```
The `@tiptap/vue-starter-kit` includes a few basics you would probably need anyway. Cool, you have got everything in place to setup tiptap! 🙌
The `@tiptap/vue-starter-kit` includes a few basics you would probably need anyway. Cool, you have got everything in place to set up tiptap! 🙌
## Create a new component
## 2. Create a new component
Create a new Vue component (you can call it `<Tiptap />`) and add the following content. This is the fastest way to get tiptap up and running with Vue.js. It will give you a very basic version of tiptap, without any buttons. No worries, you will be able to add more functionality soon.