mirror of
https://github.com/ueberdosis/tiptap.git
synced 2024-11-23 19:19:03 +08:00
docs: update content
This commit is contained in:
parent
fb3990d333
commit
60d404f2a4
@ -1,6 +1,6 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2020, überdosis GbR
|
||||
Copyright (c) 2021, überdosis GbR
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
|
@ -32,6 +32,7 @@ For casual chit-chat with others using the framework:
|
||||
* [dotCMS](http://dotcms.com/)
|
||||
* [Restruct](https://restruct.nl/)
|
||||
* [Bitcrowd](https://bitcrowd.net/)
|
||||
* [Reflect](https://reflect.app/)
|
||||
|
||||
[mymind](https://mymind.com/),
|
||||
[DocIQ](https://www.dociq.io/),
|
||||
|
@ -22,7 +22,7 @@ Be nice! The content of this editor is shared with other users from the Internet
|
||||
In case you’re wondering what kind of sorcery you need on the server to achieve this, here is the whole backend code for the demo:
|
||||
|
||||
:::warning Request early access
|
||||
Our plug & play collaboration backend hocuspocus is still work in progress. If you want to give it a try, [request early access](https://www.hocuspocus.dev).
|
||||
Our plug & play collaboration backend hocuspocus is still work in progress. If you want to give it a try, [get early access](https://www.hocuspocus.dev).
|
||||
:::
|
||||
|
||||
```js
|
||||
|
@ -96,7 +96,7 @@ const editor = new Editor({
|
||||
That example doesn’t work out of the box. As you can see, it’s configured to talk to a WebSocket server which is available under `ws://127.0.0.1:1234` (WebSocket protocol `ws://`, your local IP `127.0.0.1` and the port `1234`). You need to set this up, too.
|
||||
|
||||
#### The WebSocket backend
|
||||
To make the server part as easy as possible, we provide [an opinionated server package, called hocuspocus](http://hocuspocus.dev/) (not published yet). Let’s go through, how this will work once its released.
|
||||
To make the server part as easy as possible, we provide [an opinionated server package, called hocuspocus](http://hocuspocus.dev/) (early access for sponsors). Let’s go through, how this will work once its released.
|
||||
|
||||
Create a new project, and install the hocuspocus server as a dependency:
|
||||
|
||||
@ -220,7 +220,7 @@ Yes, it’s magic. As already mentioned, that is all based on the fantastic Y.js
|
||||
Our collaborative editing backend handles the syncing, authorization, persistence and scaling. Let’s go through a few common use cases here!
|
||||
|
||||
:::warning Request early access
|
||||
Our plug & play collaboration backend hocuspocus is still work in progress. If you want to give it a try, [request early access](https://www.hocuspocus.dev).
|
||||
Our plug & play collaboration backend hocuspocus is still work in progress. If you want to give it a try, [get early access](https://www.hocuspocus.dev).
|
||||
:::
|
||||
|
||||
### The document name
|
||||
|
@ -1,11 +1,13 @@
|
||||
# Become a sponsor 💖
|
||||
# About the project
|
||||
|
||||
## toc
|
||||
|
||||
## Introduction
|
||||
To deliver a top-notch developer experience and user experience, we put ~~hundreds~~ thousands of hours of unpaid work into tiptap. Your funding helps us to make this work more and more financially sustainable. This enables us to provide helpful support, maintain all our packages, keep everything up to date, and develop new features and extensions for tiptap.
|
||||
|
||||
Give back to the open source community and [sponsor us on GitHub](https://github.com/sponsors/ueberdosis)! ♥
|
||||
|
||||
## Your benefits as a sponsor
|
||||
## Your benefits as a sponsor 💖
|
||||
* Get early access to private repositories
|
||||
* Your issues and pull requests get a `sponsor ♥` label
|
||||
* Get a sponsor badge in all your comments on GitHub
|
||||
@ -29,6 +31,7 @@ Companies betting on tiptap probably want some peace of mind and ensure that we
|
||||
|
||||
* [Sponsor Marijn Haverbeke](https://marijnhaverbeke.nl/fund/) (ProseMirror)
|
||||
* [Sponsor Kevin Jahns](https://github.com/sponsors/dmonad) (Y.js)
|
||||
* [Sponsor y-collective](https://opencollective.com/y-collective) (Y.js + tiptap)
|
||||
|
||||
## Frequently asked questions
|
||||
|
||||
|
@ -9,11 +9,11 @@
|
||||
</banner-message> -->
|
||||
|
||||
<banner-message
|
||||
to="https://blog.ueber.io/post/tiptap-public-beta/"
|
||||
to="https://hocuspocus.dev"
|
||||
v-if="$route.name === 'home'"
|
||||
color="black"
|
||||
color="yellow"
|
||||
>
|
||||
It’s public! Read all about the tiptap v2 beta →
|
||||
Get early access to our Node.js collaboration backend →
|
||||
</banner-message>
|
||||
|
||||
<div class="app__navigation">
|
||||
|
@ -43,7 +43,7 @@
|
||||
# skip: true
|
||||
- title: Upgrade guide
|
||||
link: /overview/upgrade-guide
|
||||
- title: Become a sponsor
|
||||
- title: About the project
|
||||
link: /sponsor
|
||||
type: sponsor
|
||||
- title: Contributing
|
||||
|
@ -186,11 +186,6 @@
|
||||
image="dociq"
|
||||
to="https://www.dociq.io/"
|
||||
/>
|
||||
<!-- <logo-item
|
||||
title="Scrumpy"
|
||||
image="scrumpy"
|
||||
to="https://www.scrumpy.io"
|
||||
/> -->
|
||||
</logo-list>
|
||||
<div>
|
||||
<btn type="tertiary" icon="arrow-right-line" to="https://github.com/ueberdosis/tiptap/network/dependents?package_id=UGFja2FnZS0xMzE5OTg0ODc%3D">
|
||||
@ -206,7 +201,7 @@
|
||||
License
|
||||
</h2>
|
||||
<p>
|
||||
tiptap is licensed under <g-link to="https://github.com/ueberdosis/tiptap/blob/main/LICENSE.md">MIT</g-link>, so you are free to do whatever you want. If you are using it commercially, do the right thing and <g-link to="/sponsor">become one of our wonderful sponsors</g-link> to fund the maintenance, support and development of tiptap now and in the future. That’s all we ask for.
|
||||
tiptap is licensed under <g-link to="https://github.com/ueberdosis/tiptap/blob/main/LICENSE.md">MIT</g-link>, so you are free to do whatever you want. If you are using it commercially, <g-link to="/sponsor">become one of our wonderful sponsors</g-link> to fund the maintenance, support and development of tiptap now and in the future.
|
||||
</p>
|
||||
</div>
|
||||
</app-section>
|
||||
|
Loading…
Reference in New Issue
Block a user