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

update getting started page

Browse Source
This commit is contained in:
Hans Pagel
2020-08-13 09:37:51 +02:00
parent aa9d4a5dac
commit d0d9995fd0
3 changed files with 6 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/src/demos/GettingStarted/index.vue
View File

@@ -3,9 +3,7 @@
</template> </template>
<script> <script>
import { Editor } from '@tiptap/core' import { Editor, EditorContent } from '@tiptap/vue'
import { EditorContent, Renderer } from '@tiptap/vue'
import extensions from '@tiptap/starter-kit'
export default { export default {
components: { components: {
@@ -21,8 +19,6 @@ export default {
mounted() { mounted() {
this.editor = new Editor({ this.editor = new Editor({
content: '<p>I’m running tiptap with Vue.js. 🎉</p>', content: '<p>I’m running tiptap with Vue.js. 🎉</p>',
extensions: extensions(),
renderer: Renderer,
}) })
}, },

3
docs/src/demos/GettingStarted/style.scss
View File

@@ -1,3 +0,0 @@
.this-is-a-test {
color: black;
}

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

@@ -4,21 +4,21 @@ tiptap is framework-agnostic and works with Vue.js and React. It even works with
## Use tiptap with Vue.js ## Use tiptap with Vue.js
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 and the adapter as a dependency in your project: 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:
```bash ```bash
# Install Vue.js adapter with npm # Install Vue.js adapter with npm
npm install @tiptap/core @tiptap/starter-kit @tiptap/vue npm install @tiptap/vue @tiptap/vue-starter-kit
# Install Vue.js adapter with Yarn # Install Vue.js adapter with Yarn
yarn add @tiptap/core @tiptap/starter-kit @tiptap/vue yarn add @tiptap/vue @tiptap/vue-starter-kit
``` ```
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 setup tiptap! 🙌
## Create a new component ## Create a new component
Create a new Vue component (e. g. `<Tiptap />`) and add the following content. That is the fastest way to get tiptap up and running with Vue.js. This will give you a very basic version of tiptap, without any buttons. No worries, you will be able to add more functionality soon. 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.
<demo name="GettingStarted" /> <demo name="GettingStarted" />