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

docs: update content

Browse Source
This commit is contained in:
Hans Pagel 2021-03-03 21:26:08 +01:00
parent fc3678afc3
commit 7148a91049
3 changed files with 15 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/src/docPages/installation/nuxt.md
View File

@ -23,14 +23,14 @@ cd tiptap-example
``` ```
## 2. Install the dependencies ## 2. Install the dependencies
Okay, enough of the boring boilerplate work. Let’s finally install tiptap! For the following example you’ll need `@tiptap/core` (the actual editor) and the `@tiptap/vue-starter-kit` which has everything to get started quickly, for example a few default extensions and a basic Vue component. Okay, enough of the boring boilerplate work. Let’s finally install tiptap! For the following example you’ll need the `@tiptap/vue-2` package, with a few components, and `@tiptap/starter-kit` which has the most common extensions to get started quickly.
```bash ```bash
# install with npm # install with npm
npm install @tiptap/core @tiptap/vue-starter-kit npm install @tiptap/vue-2 @tiptap/starter-kit
# install with Yarn # install with Yarn
yarn add @tiptap/core @tiptap/vue-starter-kit yarn add @tiptap/vue-2 @tiptap/starter-kit
``` ```
If you followed step 1 and 2, you can now start your project with `npm run serve` or `yarn serve`, 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 serve` or `yarn serve`, and open [http://localhost:8080/](http://localhost:8080/) in your favorite browser. This might be different, if you’re working with an existing project.
@ -46,7 +46,8 @@ This is the fastest way to get tiptap up and running with Vue. It will give you
</template> </template>
<script> <script>
import { Editor, EditorContent, defaultExtensions } from '@tiptap/vue-starter-kit' import { Editor, EditorContent } from '@tiptap/vue-2'
import { defaultExtensions } from '@tiptap/starter-kit'
export default { export default {
components: { components: {

9
docs/src/docPages/installation/vue2.md
View File

@ -24,14 +24,14 @@ cd tiptap-example
``` ```
## 2. Install the dependencies ## 2. Install the dependencies
Okay, enough of the boring boilerplate work. Let’s finally install tiptap! For the following example you’ll need `@tiptap/core` (the actual editor) and the `@tiptap/vue-starter-kit` which has everything to get started quickly, for example a few default extensions and a basic Vue component. Okay, enough of the boring boilerplate work. Let’s finally install tiptap! For the following example you’ll need the `@tiptap/vue-2` package, with a few components, and `@tiptap/starter-kit` which has the most common extensions to get started quickly.
```bash ```bash
# install with npm # install with npm
npm install @tiptap/core @tiptap/vue-starter-kit npm install @tiptap/vue-2 @tiptap/starter-kit
# install with Yarn # install with Yarn
yarn add @tiptap/core @tiptap/vue-starter-kit yarn add @tiptap/vue-2 @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:3000/) 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` or `yarn dev`, and open [http://localhost:8080/](http://localhost:3000/) in your favorite browser. This might be different, if you’re working with an existing project.
@ -47,7 +47,8 @@ This is the fastest way to get tiptap up and running with Vue. It will give you
</template> </template>
<script> <script>
import { Editor, EditorContent, defaultExtensions } from '@tiptap/vue-starter-kit' import { Editor, EditorContent } from '@tiptap/vue-starter-kit'
import { defaultExtensions } from '@tiptap/starter-kit'
export default { export default {
components: { components: {

9
docs/src/docPages/installation/vue3.md
View File

@ -24,14 +24,14 @@ cd tiptap-example
``` ```
## 2. Install the dependencies ## 2. Install the dependencies
Okay, enough of the boring boilerplate work. Let’s finally install tiptap! For the following example you’ll need `@tiptap/core` (the actual editor) and the `@tiptap/vue-starter-kit` which has everything to get started quickly, for example a few default extensions and a basic Vue component. 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 ```bash
# install with npm # install with npm
npm install @tiptap/core @tiptap/vue-starter-kit npm install @tiptap/vue-3 @tiptap/starter-kit
# install with Yarn # install with Yarn
yarn add @tiptap/core @tiptap/vue-starter-kit 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:3000/) 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` or `yarn dev`, and open [http://localhost:8080/](http://localhost:3000/) in your favorite browser. This might be different, if you’re working with an existing project.
@ -47,7 +47,8 @@ This is the fastest way to get tiptap up and running with Vue. It will give you
</template> </template>
<script> <script>
import { Editor, EditorContent, defaultExtensions } from '@tiptap/vue-starter-kit' import { Editor, EditorContent } from '@tiptap/vue-3'
import { defaultExtensions } from '@tiptap/starter-kit'
export default { export default {
components: { components: {