diff --git a/docs/src/docPages/getting-started.md b/docs/src/docPages/getting-started.md index cab31079..a338a4f7 100644 --- a/docs/src/docPages/getting-started.md +++ b/docs/src/docPages/getting-started.md @@ -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 ``) 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.