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

update content

Browse Source
This commit is contained in:
Hans Pagel
2020-10-30 14:24:16 +01:00
parent f5763b8cc0
commit 25f4078996
36 changed files with 131 additions and 107 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/src/docPages/overview/contributing.md
View File

@@ -6,8 +6,9 @@
Tiptap would be nothing without its lively community. Contributions have always been and will always be welcome. Here is a little bit you should know, before you send your contribution:
## Welcome examples
* Improve the documentation, e. g. fix a typo, add a section
* New features for existing extensions, e. g. a new option
* Failing regression tests as bug reports
* Documentation improvements, e. g. fix a typo, add a section
* New features for existing extensions, e. g. a new configureable option
* New extensions, which don’t require changes to the core or other core extensions
* Well explained, non-breaking changes to the core

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

@@ -9,10 +9,10 @@ You’re free to use tiptap with the framework of your choice. Depending on what
Use tiptap with vanilla JavaScript for a very lightweight and raw experience. If you feel like it, you can even use it to connect tiptap with other frameworks not mentioned here.
```bash
# With npm
# with npm
npm install @tiptap/core @tiptap/starter-kit
# Or: With Yarn
# with Yarn
yarn add @tiptap/core @tiptap/starter-kit
```
@@ -33,10 +33,10 @@ new Editor({
To use tiptap with Vue.js (and tools that are based on Vue.js) install tiptap together with the Vue.js adapter in your project. We even prepared a Vue.js starter kit, which gives you a good headstart.
```bash
# With npm
# with npm
npm install @tiptap/core @tiptap/vue @tiptap/vue-starter-kit
# Or: With Yarn
# with Yarn
yarn add @tiptap/core @tiptap/vue @tiptap/vue-starter-kit
```
@@ -44,9 +44,10 @@ Create a new component and add the following content to get a basic version of t
<demo name="Overview/Installation" />
::: warning Nuxt.js
If you use Nuxt.js, note that tiptap needs to run in the client, not on the server. It’s required to wrap the editor in a `<client-only>` tag.
:::
### Nuxt.js
Note that tiptap needs to run in the client, not on the server. It’s required to wrap the editor in a `<client-only>` tag.
[Read more](https://nuxtjs.org/api/components-client-only)
<!-- ## Option 3: CodeSandbox