move general to overview namespace, transfer roadmap to github

This commit is contained in:
Hans Pagel
2020-09-09 15:15:20 +02:00
parent 78189b146b
commit 267ec93dd2
6 changed files with 16 additions and 90 deletions

View File

@@ -0,0 +1,60 @@
# 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.
## Plain JavaScript
Use tiptap with vanilla JavaScript for a very lightweight and raw experience. If you feel like it, you can even use it to connect the tiptap core with other frameworks not mentioned here.
```bash
# With npm
npm install @tiptap/core @tiptap/starter-kit
# Or: With Yarn
yarn add @tiptap/core @tiptap/starter-kit
```
Great, that should be enough to start. Here is the most essential code you need to get a running instance of tiptap:
```js
import { Editor } from '@tiptap/core'
import defaultExtensions from '@tiptap/starter-kit'
new Editor({
element: document.getElementsByClassName('element'),
extensions: defaultExtensions(),
content: '<p>Your content.</p>',
})
```
## 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. Its great to fiddle around without setting up a local project and its great to share your code with others.
Its also amazing for bug reports. Try to recreate a bug there and share it with us before you [file an issue on GitHub](https://github.com/ueberdosis/tiptap-next/issues/new). This helps a ton to fix bugs faster.
* [Vue.js/tiptap on CodeSandbox](https://codesandbox.io/s/vue-issue-template-h0g28)
## CDN
> ⚠️ This is broken and doesnt work. Dont use it. We are working on it.
```html
<script src="https://cdn.jsdelivr.net/npm/tiptap@1.29.4/dist/tiptap.min.js"></script>
```

View File

@@ -0,0 +1,3 @@
# Roadmap
See https://github.com/ueberdosis/tiptap-next/projects/1

View File

@@ -0,0 +1,6 @@
# Upgrade Guide
- reasons to upgrade to tiptap 2
- link to roadmap
## Upgrading from 1.x to 2.x