This commit is contained in:
Philipp Kühn 2020-11-11 21:00:57 +01:00
commit 505b51b3cc
11 changed files with 134 additions and 23 deletions

35
.github/ISSUE_TEMPLATE/bug_report.md vendored Normal file
View File

@ -0,0 +1,35 @@
---
name: Bug report
about: Create a report to help us improve
url: https://github.com/ueberdosis/tiptap-next/issues/new
title: ''
labels: bug
assignees: ''
---
**What happens?**
A clear and concise description of what the bug is.
**How can others reproduce the issue?**
Steps to reproduce the behavior:
1. Go to …
2. Type in …
3. Click on …
4. See error message
Create a new Codesandbox replicating your error
https://codesandbox.io/s/vue-issue-template-h0g28
**What behavior did you expect?**
A clear and concise description of what you expected to happen.
**Do you have a screenshot?**
If applicable, add screenshots to help explain your problem.
**Whats your environment?**
- Operating system
- Browser
- Mobile/desktop
**What else?**
Add any other context about the problem here.

5
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
# - name: Ask a question
# url: https://github.com/ueberdosis/tiptap/discussions/new
# about: Ask the community for help

View File

@ -0,0 +1,19 @@
---
name: Feature request
about: Suggest a new feature for tiptap
title: ''
labels: feature request
assignees: ''
---
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. For example: Im always frustrated when …
**Describe the solution youd like**
A clear and concise description of what you want to happen.
**Describe alternatives youve considered**
A clear and concise description of any alternative solutions or features youve considered.
**Additional context**
Add any other context or screenshots about the feature request here.

20
.github/ISSUE_TEMPLATE/feedback.md vendored Normal file
View File

@ -0,0 +1,20 @@
---
name: Feedback on the documentation
about: Share what we need to explain better
url: https://github.com/ueberdosis/tiptap-next/issues/new
title: ''
labels: documentation
assignees: ''
---
**Which part of the documentation have you read?**
Ive been to the following page of the documentation …
**Did you find the content helpful?**
I think this part is really good: …
**What was hard to understand, missing or misleading?**
But you really need to improve …
**What else?**
Add any other context here.

View File

@ -1,7 +1,8 @@
# tiptap 2.x Preview
> Dont use this in production. Its full of bugs and the API will likely change.
> Dont try this at home! Nothing here is production-ready, dont use it anywhere.
A renderless and extendable rich-text editor for [Vue.js](https://github.com/vuejs/vue)
# tiptap 2 (Preview!)
A renderless and extendable rich-text editor, based on [ProseMirror](https://github.com/ProseMirror/prosemirror), which is already in use at many well-known companies such as *New York Times*, *The Guardian* or *Atlassian*.
<!-- [![Version](https://img.shields.io/npm/v/tiptap.svg?label=version)](https://www.npmjs.com/package/tiptap)
[![Downloads](https://img.shields.io/npm/dm/tiptap.svg)](https://npmcharts.com/compare/tiptap?minimal=true)
@ -10,25 +11,21 @@ A renderless and extendable rich-text editor for [Vue.js](https://github.com/vue
[![Build Status](https://github.com/ueberdosis/tiptap-next/workflows/build/badge.svg)](https://github.com/ueberdosis/tiptap-next/actions)
[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis)
## Roadmap
- [x] Proof of concept
- [x] Building out the editor
- [x] Adding a bunch of extensions
- [x] Creating a few examples
- [ ] Giving sponsors access to gather feedback
- [ ] Incorporate feedback
- [ ] Publicly release version 2.0-beta
- [ ] Squash bugs, build more extensions
- [ ] Release version 2.0
## Feedback
Were looking for your feedback to improve tiptap 2 before the first public release! Share everything that helps to make it better for everyone!
* Create issues on GitHub! [Link](https://github.com/ueberdosis/tiptap-next/issues)
* Send an email! [humans@tiptap.dev](mailto:humans@tiptap.dev)
* Follow us on Twitter! [@hanspagel](https://twitter.com/hanspagel) [@_philippkuehn](https://twitter.com/_philippkuehn)
## Why we built tiptap
We were looking for a text editor for [Vue.js](https://github.com/vuejs/vue) and found some solutions that didnt really satisfy me. The editor should be easy to extend and not based on old dependencies such as jQuery. For React there is already a great editor called [Slate.js](https://github.com/ianstormtaylor/slate), which impresses with its modularity. I came across [ProseMirror](https://github.com/prosemirror) and decided to build on it. ProseMirror is a toolkit for building rich-text editors that are already in use at many well-known companies such as *Atlassian* or *New York Times*.
We were looking for a text editor for [Vue.js](https://github.com/vuejs/vue) and found some solutions that didnt really satisfy us. An editor should be easy to extend and not based on old dependencies such as jQuery. For React there is already a great editor called [Slate.js](https://github.com/ianstormtaylor/slate), which impresses with its modularity. We came across [ProseMirror](https://github.com/prosemirror) and decided to build on it. ProseMirror is a toolkit for building rich-text editors that are already in use at many well-known companies such as *Atlassian* or *New York Times*.
### What does `renderless` mean?
With renderless components you'll have (almost) full control over markup and styling. We dont want to tell you what a menu should look like or where it should be rendered in the DOM. Thats all up to you. There is also a [great article about renderless components](https://adamwathan.me/renderless-components-in-vuejs/) by Adam Wathan.
### How is the data stored under the hood?
You can save your data as a raw `HTML` string or can get a `JSON`-serializable representation of your document. And of course, you can pass these two types back to the editor.
You can save your data as a raw `HTML` string or can get a `JSON`-serializable representation of your document. And of course, you can also pass `HTML` or `JSON` content back to the editor.
## 💖 Sponsor the development
Are you using tiptap in production? We need your sponsorship to maintain, update and develop tiptap. [Become a Sponsor now!](https://github.com/sponsors/ueberdosis)
@ -39,12 +36,38 @@ To check out some live examples, visit [next.tiptap.dev](https://next.tiptap.dev
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Maintainers
- [Philipp Kühn](https://github.com/philippkuehn) (development)
- [Hans Pagel](https://github.com/hanspagel) (documentation)
## Premium Sponsors
- [überdosis](https://ueberdosis.io/)
- Jason Nelson from [mymind](https://mymind.com/)
- Gordon Mickel from [DocIQ](https://www.dociq.io/)
## Credits
- [Philipp Kühn](https://github.com/philippkuehn)
- [Hans Pagel](https://github.com/hanspagel)
- [Christoph Flathmann](https://github.com/Chrissi2812)
- [Erick Wilder](https://github.com/erickwilder)
- [Marius Tolzmann](https://github.com/mariux)
- [jjangga0214](https://github.com/jjangga0214)
- [Maya Nedeljkovich](https://github.com/mayacoda)
- [Ryan Bliss](https://github.com/ryanbliss)
- [Gregor](https://github.com/gambolputty)
- [All Contributors](../../contributors)
## Related Projects
- [prosemirror-php](https://github.com/ueberdosis/prosemirror-php) by @hanspagel
- [html-to-prosemirror](https://github.com/ueberdosis/html-to-prosemirror) by @hanspagel
- [prosemirror-to-html](https://github.com/ueberdosis/prosemirror-to-html) by @hanspagel
- [tiptap-svelte](https://github.com/andrewjk/tiptap-svelte) by @andrewjk
- [Laravel Nova Tiptap Editor Field](https://github.com/manogi/nova-tiptap) by @manogi
- [WYSIWYG editor for Vuetify](https://github.com/iliyaZelenko/tiptap-vuetify) by @iliyaZelenko
- [Quasar Tiptap Demo](https://github.com/kfields/quasar-tiptap-demo) @kfields
- [Python Library that converts tiptap JSON](https://github.com/scrolltech/tiptapy) @scrolltech
- [WYSIWYG editor for Element UI](https://github.com/Leecason/element-tiptap) by @Leecason
- [WYSIWYG editor for Quasar Framework](https://github.com/donotebase/quasar-tiptap) by @mekery
## Love our work?
[Sponsor us](https://github.com/sponsors/ueberdosis) ❤️
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

View File

@ -0,0 +1,7 @@
# Feedback
Were looking for your feedback to improve tiptap 2 before the first public release! Share everything that helps to make it better for everyone!
* Create issues on GitHub! [Link](https://github.com/ueberdosis/tiptap-next/issues)
* Send an email! [humans@tiptap.dev](mailto:humans@tiptap.dev)
* Follow us on Twitter! [@hanspagel](https://twitter.com/hanspagel) [@_philippkuehn](https://twitter.com/_philippkuehn) [@_ueberdosis](https://twitter.com/_ueberdosis)

View File

@ -12,7 +12,7 @@ Kurfürstenstraße 56<br>
Represented by: Sven Adlung, Patrick Baber, Nick Hirche, Philip Isik, Timo Isik, Philipp Kühn, Hans Pagel, Sebastian Schrama
We dont provide email support for tiptap, but if you have some legal issues, privacy or security concerns, send us an email to [hans.pagel@ueber.io](mailto:hans.pagel@ueber.io). For everything else, [please use GitHub issues](https://github.com/ueberdosis/tiptap-next/issues).
We dont provide email support for tiptap, but if you have some legal issues, privacy or security concerns, send us an email to [humans@tiptap.dev](mailto:humans@tiptap.dev). For everything else, [please use GitHub issues](https://github.com/ueberdosis/tiptap-next/issues).
## Dispute resolution
The European Commission provides a platform for online dispute resolution (OS): https://ec.europa.eu/consumers/odr.

View File

@ -5,7 +5,7 @@
## Introduction
We value your privacy and question everything that stores or processes your personal information. With that in mind, we still need a few external services to publish tiptap.
We dont provide email support for tiptap, but if you have some legal issues, privacy or security concerns, send us an email to [hans.pagel@ueber.io](mailto:hans.pagel@ueber.io). For everything else, [please use GitHub issues](https://github.com/ueberdosis/tiptap-next/issues).
We dont provide email support for tiptap, but if you have some legal issues, privacy or security concerns, send us an email to [humans@tiptap.dev](mailto:humans@tiptap.dev). For everything else, [please use GitHub issues](https://github.com/ueberdosis/tiptap-next/issues).
## List of Services

View File

@ -14,10 +14,10 @@ If youre using tiptap in a commercial project or just want to give back to th
Does that sound good? [Sponsor us on GitHub!](https://github.com/sponsors/ueberdosis)
## I cant use GitHub.
If youre a company, dont want to use GitHub, dont have a credit card or want a proper invoice form us, just reach out to us at [hans.pagel@ueber.io](mailto:hans.pagel@ueber.io).
If youre a company, dont want to use GitHub, dont have a credit card or want a proper invoice form us, just reach out to us at [humans@tiptap.dev](mailto:humans@tiptap.dev).
## I want consulting.
We dont do any calls, consulting or personal support. If you have an issue, a question, want to talk something through or anything else, [please use GitHub issues](https://github.com/ueberdosis/tiptap-next/issues), to keep everything accessible for the whole community.
## Can we have a call?
Nope, we are big fans of asynchronous communication. If you really need to reach out in private, send us an email to [hans.pagel@ueber.io](mailto:hans.pagel@ueber.io), but dont expect technical email support.
Nope, we are big fans of asynchronous communication. If you really need to reach out in private, send us an email to [humans@tiptap.dev](mailto:humans@tiptap.dev), but dont expect technical email support.

View File

@ -79,7 +79,7 @@
<g-link class="app__name" to="/">
{{ $static.metadata.siteName }}
</g-link>
<g-link to="https://github.com/ueberdosis/tiptap">
<g-link to="https://github.com/ueberdosis/tiptap-next">
<svg
class="app__github"
width="15"

View File

@ -31,6 +31,8 @@
link: /examples/minimalist
- title: Export HTML or JSON
link: /examples/export-html-or-json
- title: Feedback
link: /overview/feedback
- title: Guide
items: