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

minor improvements

Browse Source
This commit is contained in:
Hans Pagel
2020-09-21 16:59:28 +02:00
parent 26af779d22
commit ece9d0a554
16 changed files with 53 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
docs/src/docPages/overview/installation.md
View File

@@ -1,6 +1,28 @@
# Installation
tiptap has a very modular package structure and is independent of any framework. Depending on what you want to do with tiptap there are a few different ways to install tiptap in your project. Choose the way that fits your project best.
tiptap has a modular package structure and is independent of any framework. Depending on what you want to do with tiptap there are a few different ways to install tiptap in your project. Choose the way that fits your project best.
## Vue.js
To use tiptap with Vue.js (and tools that are based on Vue.js) install tiptap together with the Vue.js rendering adapter in your project. We even prepared a Vue.js starter kit, which gives you a good headstart.
```bash
# With npm
npm install @tiptap/core @tiptap/vue @tiptap/vue-starter-kit
# Or: With Yarn
yarn add @tiptap/core @tiptap/vue @tiptap/vue-starter-kit
```
| Package | Description |
| -------------------------------------------------------------------------------- | ----------------------------------- |
| [@tiptap/core](https://www.npmjs.com/package/@tiptap/core) | The actual editor |
| [@tiptap/vue](https://www.npmjs.com/package/@tiptap/vue) | Rendering for Vue.js |
| [@tiptap/vue-starter-kit](https://www.npmjs.com/package/@tiptap/vue-starter-kit) | Installs the most common extensions |
Create a new component and add the following content to get a basic version of tiptap:
<demo name="General/Installation" />
## Plain JavaScript
@@ -27,22 +49,6 @@ new Editor({
})
```
## Vue.js
To use tiptap with Vue.js (and tools that are based on Vue.js) install the Vue.js adapter in your project:
```bash
# With npm
npm install @tiptap/vue @tiptap/vue-starter-kit
# Or: With Yarn
yarn add @tiptap/vue @tiptap/vue-starter-kit
```
We even prepared a Vue.js starter kit for you. That should give you a good headstart. Create a new component and add the following content to get a basic version of tiptap:
<demo name="General/Installation" />
## CodeSandbox
CodeSandbox is an online coding environment. It’s great to fiddle around without setting up a local project and it’s great to share your code with others.