ianhitchman/tiptap
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

docs: remove Yarn instructions

Browse Source
This commit is contained in:
Hans Pagel
2021-11-09 11:56:27 +01:00
parent 345abcc00c
commit 7e476ec617
55 changed files with 33 additions and 271 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/installation/vue3.md
View File

@@ -16,28 +16,24 @@ The following guide describes how to integrate Tiptap with your [Vue](https://vu
## 1. Create a project (optional)
If you already have an existing Vue project, that’s fine too. Just skip this step and proceed with the next step.
For the sake of this guide, let’s start with a fresh Vue project called `tiptap-example`. The Vue CLI sets up everything we need, just select the Vue 3 template.
For the sake of this guide, let’s start with a fresh Vue project called `my-tiptap-project`. The Vue CLI sets up everything we need, just select the Vue 3 template.
```bash
# create a project
vue create Tiptap-example
vue create my-tiptap-project
# change directory
cd Tiptap-example
cd my-tiptap-project
```
## 2. Install the dependencies
Okay, enough of the boring boilerplate work. Let’s finally install Tiptap! For the following example you’ll need the `@tiptap/vue-3` package, with a few components, and `@tiptap/starter-kit` which has the most common extensions to get started quickly.
```bash
# install with npm
npm install @tiptap/vue-3 @tiptap/starter-kit
# install with Yarn
yarn add @tiptap/vue-3 @tiptap/starter-kit
```
If you followed step 1 and 2, you can now start your project with `npm run dev` or `yarn dev`, and open [http://localhost:8080](http://localhost:8080) in your favorite browser. This might be different, if you’re working with an existing project.
If you followed step 1 and 2, you can now start your project with `npm run dev`, and open [http://localhost:8080](http://localhost:8080) in your favorite browser. This might be different, if you’re working with an existing project.
## 3. Create a new component
To actually start using Tiptap, you’ll need to add a new component to your app. Let’s call it `Tiptap` and put the following example code in `components/Tiptap.vue`.