From 922f25e8cda4334a14806d9e9f5b5f3ca20b3d76 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Philipp=20Ku=CC=88hn?= Date: Wed, 14 Apr 2021 09:53:17 +0200 Subject: [PATCH 01/17] remove parentConfig from code block extension for now, see #259 --- .../extension-code-block-lowlight/src/code-block-lowlight.ts | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/packages/extension-code-block-lowlight/src/code-block-lowlight.ts b/packages/extension-code-block-lowlight/src/code-block-lowlight.ts index 115be13cb..96f60d549 100644 --- a/packages/extension-code-block-lowlight/src/code-block-lowlight.ts +++ b/packages/extension-code-block-lowlight/src/code-block-lowlight.ts @@ -14,7 +14,8 @@ export const CodeBlockLowlight = CodeBlock.extend({ addProseMirrorPlugins() { return [ - ...this.parentConfig.addProseMirrorPlugins?.() || [], + // disable for now, see: https://github.com/ueberdosis/tiptap-next/issues/259#issuecomment-817954835 + // ...this.parentConfig.addProseMirrorPlugins?.() || [], LowlightPlugin({ name: 'codeBlock', lowlight: this.options.lowlight, From 1e9c322b7cea9b8abba8ed953dfb4fb80b49744b Mon Sep 17 00:00:00 2001 From: philippkuehn Date: Wed, 14 Apr 2021 07:54:30 +0000 Subject: [PATCH 02/17] ci: fix code style linting errors --- docs/src/demos/Examples/CodeBlockLanguage/index.vue | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/demos/Examples/CodeBlockLanguage/index.vue b/docs/src/demos/Examples/CodeBlockLanguage/index.vue index 2179ef41c..f1ab6a268 100644 --- a/docs/src/demos/Examples/CodeBlockLanguage/index.vue +++ b/docs/src/demos/Examples/CodeBlockLanguage/index.vue @@ -14,10 +14,10 @@ import Document from '@tiptap/extension-document' import Paragraph from '@tiptap/extension-paragraph' import Text from '@tiptap/extension-text' import CodeBlockLowlight from '@tiptap/extension-code-block-lowlight' +import lowlight from 'lowlight' import CodeBlockComponent from './CodeBlockComponent' // load all highlight.js languages -import lowlight from 'lowlight' // load specific languages only // import lowlight from 'lowlight/lib/core' From 125f16e967a950f9f876b65f6fbfbeb37f64981a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Philipp=20Ku=CC=88hn?= Date: Wed, 14 Apr 2021 10:00:39 +0200 Subject: [PATCH 03/17] Publish - @tiptap/extension-code-block-lowlight@2.0.0-beta.4 --- packages/extension-code-block-lowlight/CHANGELOG.md | 11 +++++++++++ packages/extension-code-block-lowlight/package.json | 2 +- 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/packages/extension-code-block-lowlight/CHANGELOG.md b/packages/extension-code-block-lowlight/CHANGELOG.md index 9ec7d10ca..19c2d2a30 100644 --- a/packages/extension-code-block-lowlight/CHANGELOG.md +++ b/packages/extension-code-block-lowlight/CHANGELOG.md @@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# [2.0.0-beta.4](https://github.com/ueberdosis/tiptap-next/compare/@tiptap/extension-code-block-lowlight@2.0.0-beta.3...@tiptap/extension-code-block-lowlight@2.0.0-beta.4) (2021-04-14) + + +### Bug Fixes + +* fix lowlight decorations for vue 3 ([daa5dc0](https://github.com/ueberdosis/tiptap-next/commit/daa5dc0fb1ec2db6889565fc9c091f3dbdbbda6d)) + + + + + # [2.0.0-beta.3](https://github.com/ueberdosis/tiptap-next/compare/@tiptap/extension-code-block-lowlight@2.0.0-beta.2...@tiptap/extension-code-block-lowlight@2.0.0-beta.3) (2021-04-12) diff --git a/packages/extension-code-block-lowlight/package.json b/packages/extension-code-block-lowlight/package.json index c369d4718..d84c336d7 100644 --- a/packages/extension-code-block-lowlight/package.json +++ b/packages/extension-code-block-lowlight/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-code-block-lowlight", "description": "code block extension for tiptap", - "version": "2.0.0-beta.3", + "version": "2.0.0-beta.4", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", From b076405c323b919383b0b9c24280d0a824cb63ee Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Philipp=20Ku=CC=88hn?= Date: Wed, 14 Apr 2021 10:04:30 +0200 Subject: [PATCH 04/17] update eslint config --- .eslintrc.js | 1 + docs/src/demos/Examples/CodeBlockLanguage/index.vue | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/.eslintrc.js b/.eslintrc.js index 9be752504..de4f60c17 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -38,6 +38,7 @@ module.exports = { 'no-alert': 'off', 'no-console': ['warn', { allow: ['warn', 'error'] }], semi: ['error', 'never'], + 'import/order': 'off', 'import/extensions': 'off', 'import/no-extraneous-dependencies': 'off', 'import/no-unresolved': 'off', diff --git a/docs/src/demos/Examples/CodeBlockLanguage/index.vue b/docs/src/demos/Examples/CodeBlockLanguage/index.vue index f1ab6a268..2179ef41c 100644 --- a/docs/src/demos/Examples/CodeBlockLanguage/index.vue +++ b/docs/src/demos/Examples/CodeBlockLanguage/index.vue @@ -14,10 +14,10 @@ import Document from '@tiptap/extension-document' import Paragraph from '@tiptap/extension-paragraph' import Text from '@tiptap/extension-text' import CodeBlockLowlight from '@tiptap/extension-code-block-lowlight' -import lowlight from 'lowlight' import CodeBlockComponent from './CodeBlockComponent' // load all highlight.js languages +import lowlight from 'lowlight' // load specific languages only // import lowlight from 'lowlight/lib/core' From edb4a0da3b6a16f59c622c23cf6feee263e60097 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Philipp=20Ku=CC=88hn?= Date: Wed, 14 Apr 2021 10:05:29 +0200 Subject: [PATCH 05/17] bump --- packages/extension-code-block-lowlight/package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/extension-code-block-lowlight/package.json b/packages/extension-code-block-lowlight/package.json index d84c336d7..f7ab875a1 100644 --- a/packages/extension-code-block-lowlight/package.json +++ b/packages/extension-code-block-lowlight/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-code-block-lowlight", "description": "code block extension for tiptap", - "version": "2.0.0-beta.4", + "version": "2.0.0-beta.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", From 6e8970566b356a5cfaa225fea621d50c419d73f7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Philipp=20Ku=CC=88hn?= Date: Wed, 14 Apr 2021 10:05:57 +0200 Subject: [PATCH 06/17] Publish - @tiptap/extension-code-block-lowlight@2.0.0-beta.6 --- packages/extension-code-block-lowlight/CHANGELOG.md | 8 ++++++++ packages/extension-code-block-lowlight/package.json | 2 +- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/packages/extension-code-block-lowlight/CHANGELOG.md b/packages/extension-code-block-lowlight/CHANGELOG.md index 19c2d2a30..027f1af99 100644 --- a/packages/extension-code-block-lowlight/CHANGELOG.md +++ b/packages/extension-code-block-lowlight/CHANGELOG.md @@ -3,6 +3,14 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# [2.0.0-beta.6](https://github.com/ueberdosis/tiptap-next/compare/@tiptap/extension-code-block-lowlight@2.0.0-beta.4...@tiptap/extension-code-block-lowlight@2.0.0-beta.6) (2021-04-14) + +**Note:** Version bump only for package @tiptap/extension-code-block-lowlight + + + + + # [2.0.0-beta.4](https://github.com/ueberdosis/tiptap-next/compare/@tiptap/extension-code-block-lowlight@2.0.0-beta.3...@tiptap/extension-code-block-lowlight@2.0.0-beta.4) (2021-04-14) diff --git a/packages/extension-code-block-lowlight/package.json b/packages/extension-code-block-lowlight/package.json index f7ab875a1..c95055ead 100644 --- a/packages/extension-code-block-lowlight/package.json +++ b/packages/extension-code-block-lowlight/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-code-block-lowlight", "description": "code block extension for tiptap", - "version": "2.0.0-beta.5", + "version": "2.0.0-beta.6", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", From 0e8de02bddaa4cecfe8f2a69ff613f58486e4a5b Mon Sep 17 00:00:00 2001 From: Hans Pagel Date: Wed, 14 Apr 2021 20:33:40 +0200 Subject: [PATCH 07/17] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c57324c12..e92297eef 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # tiptap 2 (Sponsors preview!) +[![Build Status](https://github.com/ueberdosis/tiptap-next/workflows/build/badge.svg)](https://github.com/ueberdosis/tiptap-next/actions) [![Version](https://img.shields.io/npm/v/@tiptap/core.svg?label=version)](https://www.npmjs.com/package/@tiptap/core) [![Downloads](https://img.shields.io/npm/dm/@tiptap/core.svg)](https://npmcharts.com/compare/@tiptap/core?minimal=true) [![License](https://img.shields.io/npm/l/@tiptap/core.svg)](https://www.npmjs.com/package/@tiptap/core) -[![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) [![Chat](https://img.shields.io/badge/chat-on%20discord-7289da.svg?sanitize=true)](https://discord.gg/WtJ49jGshW) +[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis) A headless 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*. From 2a9feecd4fda952bba239a3d14039377ccbd007a Mon Sep 17 00:00:00 2001 From: Hans Pagel Date: Wed, 14 Apr 2021 20:34:33 +0200 Subject: [PATCH 08/17] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index e92297eef..e272478d1 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,8 @@ A headless 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*. +> If you’re looking for tiptap v1, [click here](https://github.com/ueberdosis/tiptap/tree/main). + ## Feedback We are looking for your feedback to improve tiptap 2 before the first public release! Share everything that helps to make it better for everyone! From a2dbaa778108d01d853575dad1f5d664b51ba65a Mon Sep 17 00:00:00 2001 From: Hans Pagel Date: Wed, 14 Apr 2021 21:17:38 +0200 Subject: [PATCH 09/17] update README.md --- README.md | 111 ++++++++++++++++++++++++------------------------------ 1 file changed, 49 insertions(+), 62 deletions(-) diff --git a/README.md b/README.md index e272478d1..a9c747b67 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,6 @@ -# tiptap 2 (Sponsors preview!) +# tiptap 2 +A headless, framwork-agnostic and extendable rich text editor, based on [ProseMirror](https://github.com/ProseMirror/prosemirror). + [![Build Status](https://github.com/ueberdosis/tiptap-next/workflows/build/badge.svg)](https://github.com/ueberdosis/tiptap-next/actions) [![Version](https://img.shields.io/npm/v/@tiptap/core.svg?label=version)](https://www.npmjs.com/package/@tiptap/core) [![Downloads](https://img.shields.io/npm/dm/@tiptap/core.svg)](https://npmcharts.com/compare/@tiptap/core?minimal=true) @@ -6,75 +8,60 @@ [![Chat](https://img.shields.io/badge/chat-on%20discord-7289da.svg?sanitize=true)](https://discord.gg/WtJ49jGshW) [![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis) -A headless 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*. +> If you’re looking for tiptap 1, [click here](https://github.com/ueberdosis/tiptap/tree/main). -> If you’re looking for tiptap v1, [click here](https://github.com/ueberdosis/tiptap/tree/main). - -## Feedback -We are looking for your feedback to improve tiptap 2 before the first public release! Share everything that helps to make it better for everyone! - -* Join the Discord server! [Link](https://discord.gg/WtJ49jGshW) -* 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! [@tiptap_editor](https://twitter.com/tiptap_editor) [@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 didn’t 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 `headless` mean? -With headless components you'll have (almost) full control over markup and styling. We don’t want to tell you what a menu should look like or where it should be rendered in the DOM. That’s all up to you. There is also a [great article about headless 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 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) +## Examples +Have a look at the [examples to see tiptap in action](https://next.tiptap.dev/examples). ## Documentation -To check out some live examples, visit [next.tiptap.dev](https://next.tiptap.dev/). +The full documentation is a available on [next.tiptap.dev](https://next.tiptap.dev/installation). + +## Community +For help, discussion about best practices, or any other conversation that would benefit from being searchable: + +[Discuss tiptap on GitHub](https://github.com/ueberdosis/tiptap/discussions) + +For casual chit-chat with others using the framework: + +[Join the tiptap Discord Server](https://discord.gg/WtJ49jGshW) + +## 💖 Sponsors +* [überdosis](https://ueberdosis.io/) +* [Ziff Media Group](https://ziffmedia.com/) +* [Incyte Studios](https://incytestudios.com/) +* [dotCMS](http://dotcms.com/) +* [Restruct](https://restruct.nl/) + +[mymind](https://mymind.com/), +[DocIQ](https://www.dociq.io/), +[Apostrophe CMS](https://apostrophecms.com/), +[Ycode](https://www.ycode.com/), +[@impactvelocity](https://github.com/impactvelocity), +[Flow Mobile](https://www.flowmobile.app/), +[Gretel](http://www.gretel.co/), +[Omics Data Automation](https://www.omicsautomation.com/), +[Novadiscovery](http://www.novadiscovery.com/), +[Atlan Technologies](https://atlan.com/), +[Gamma](https://gamma.app/), +[Kirchner Consulting](https://kirchnerconsulting.ch/), +[IT Xpert](https://itxpert.ch/) + +Using tiptap in production? Invest in the future of tiptap and [become a sponsor!](https://github.com/sponsors/ueberdosis) ## Contributing Please see [CONTRIBUTING](CONTRIBUTING.md) for details. -## Maintainers -- [Philipp Kühn](https://github.com/philippkuehn) (developer) -- [Hans Pagel](https://github.com/hanspagel) (maintainer) +## Contributors +[Sam Willis](https://github.com/samwillis), +[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) -## Premium Sponsors -- [überdosis](https://ueberdosis.io/) -- [mymind](https://mymind.com/) -- [DocIQ](https://www.dociq.io/) -- [Apostrophe CMS](https://apostrophecms.com/) -- [Ycode](https://www.ycode.com/) -- [@impactvelocity](https://github.com/impactvelocity) -- [Flow Mobile](https://www.flowmobile.app/) - -## Credits -- [Sam Willis](https://github.com/samwillis) -- [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) - -## Links -- https://github.com/ueberdosis/awesome-tiptap - -## Become a sponsor -Your benefits as a sponsor: - -* Give back to the open source community -* Get early access to private repositories -* Ensure the further maintenace and development of tiptap -* Your issues and pull requests get a `sponsor 💖` label -* Get a sponsor badge in all your comments on GitHub -* Show support in your GitHub profile -* Receive monthly reports about our open source work - -Does that sound good? [Become a sponsor!](https://github.com/sponsors/ueberdosis) +[All Contributors](../../contributors) ## License The MIT License (MIT). Please see [License File](LICENSE.md) for more information. From a71a084200d6a241ed925486e31168aabaaab249 Mon Sep 17 00:00:00 2001 From: Hans Pagel Date: Wed, 14 Apr 2021 21:21:12 +0200 Subject: [PATCH 10/17] update README.md --- README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a9c747b67..91c1f9b77 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ For casual chit-chat with others using the framework: [Atlan Technologies](https://atlan.com/), [Gamma](https://gamma.app/), [Kirchner Consulting](https://kirchnerconsulting.ch/), -[IT Xpert](https://itxpert.ch/) +[IT Xpert](https://itxpert.ch/) and hundreds of awesome inviduals. Using tiptap in production? Invest in the future of tiptap and [become a sponsor!](https://github.com/sponsors/ueberdosis) @@ -59,9 +59,7 @@ Please see [CONTRIBUTING](CONTRIBUTING.md) for details. [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) +[Gregor](https://github.com/gambolputty) and [many more](../../contributors). ## License The MIT License (MIT). Please see [License File](LICENSE.md) for more information. From ab9888fcc4a0bc7eec0535395ac6acf99eec4100 Mon Sep 17 00:00:00 2001 From: Hans Pagel Date: Wed, 14 Apr 2021 21:22:42 +0200 Subject: [PATCH 11/17] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 91c1f9b77..0249ccaf2 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # tiptap 2 -A headless, framwork-agnostic and extendable rich text editor, based on [ProseMirror](https://github.com/ProseMirror/prosemirror). +A headless, framework-agnostic and extendable rich text editor, based on [ProseMirror](https://github.com/ProseMirror/prosemirror). [![Build Status](https://github.com/ueberdosis/tiptap-next/workflows/build/badge.svg)](https://github.com/ueberdosis/tiptap-next/actions) [![Version](https://img.shields.io/npm/v/@tiptap/core.svg?label=version)](https://www.npmjs.com/package/@tiptap/core) From 0bb6106c554751d7b6b4ccb24dc61ff0ad1b15a9 Mon Sep 17 00:00:00 2001 From: Hans Pagel Date: Thu, 15 Apr 2021 09:14:31 +0200 Subject: [PATCH 12/17] update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 91c1f9b77..95edd2762 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ A headless, framwork-agnostic and extendable rich text editor, based on [ProseMi [![Chat](https://img.shields.io/badge/chat-on%20discord-7289da.svg?sanitize=true)](https://discord.gg/WtJ49jGshW) [![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis) -> If you’re looking for tiptap 1, [click here](https://github.com/ueberdosis/tiptap/tree/main). +> If you’re looking for tiptap 1, [click here](https://github.com/ueberdosis/tiptap/tree/v1). ## Examples Have a look at the [examples to see tiptap in action](https://next.tiptap.dev/examples). From 21855542262cf5ecd6dad01e24124333bf96f706 Mon Sep 17 00:00:00 2001 From: Hans Pagel Date: Thu, 15 Apr 2021 09:15:18 +0200 Subject: [PATCH 13/17] update redirects --- docs/static/_redirects | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/static/_redirects b/docs/static/_redirects index b66aa4ead..c3372f3c7 100644 --- a/docs/static/_redirects +++ b/docs/static/_redirects @@ -1,4 +1,4 @@ /overview / -/examples /examples/basic -/guide /guide/get-started +/examples /examples/default +/guide /guide/configuration /api /api/concept From f05e23734624535e795ef0f144ac0000dc95dc0d Mon Sep 17 00:00:00 2001 From: Hans Pagel Date: Thu, 15 Apr 2021 19:33:51 +0200 Subject: [PATCH 14/17] docs: update content --- docs/src/docPages/api/concept.md | 22 +++++++++---------- docs/src/docPages/api/marks.md | 2 +- docs/src/docPages/api/nodes.md | 2 +- ...ock-language.md => syntax-highlighting.md} | 2 +- docs/src/links.yaml | 10 ++------- 5 files changed, 16 insertions(+), 22 deletions(-) rename docs/src/docPages/examples/{code-block-language.md => syntax-highlighting.md} (66%) diff --git a/docs/src/docPages/api/concept.md b/docs/src/docPages/api/concept.md index 4d26a5ebc..d1ba2d09f 100644 --- a/docs/src/docPages/api/concept.md +++ b/docs/src/docPages/api/concept.md @@ -13,14 +13,14 @@ Extensions add [nodes](/api/nodes), [marks](/api/marks) and/or [functionalities] ## Vocabulary ProseMirror has its own vocabulary and you’ll stumble upon all those words now and then. Here is a short overview of the most common words we use in the documentation. -| Word | Description | -| ----------- | ------------------------------------------------------------------------ | -| Schema | Configures the structure your content can have. | -| Document | The actual content in your editor. | -| State | Everything to describe the current content and selection of your editor. | -| Transaction | A change to the state (updated selection, content, …) | -| Extension | Registeres new functionality. | -| Node | Adds blocks, like heading, paragraph. | -| Mark | Adds inline formatting, for example bold or italic. | -| Command | Execute an action inside the editor, that somehow changes the state. | -| Decoration | Styling on top of the document, for example to highlight mistakes. | +| Word | Description | +| ----------- | --------------------------------------------------------------------------------- | +| Schema | Configures the structure your content can have. | +| Document | The actual content in your editor. | +| State | Everything to describe the current content and selection of your editor. | +| Transaction | A change to the state (updated selection, content, …) | +| Extension | Registeres new functionality. | +| Node | Nodes are a type of content, for example a heading or a paragraph. | +| Mark | One or multiple marks can be applied to nodes, for example for inline formatting. | +| Command | Execute an action inside the editor, that somehow changes the state. | +| Decoration | Styling on top of the document, for example to highlight mistakes. | diff --git a/docs/src/docPages/api/marks.md b/docs/src/docPages/api/marks.md index 840e9c136..6d30a27af 100644 --- a/docs/src/docPages/api/marks.md +++ b/docs/src/docPages/api/marks.md @@ -3,7 +3,7 @@ ## toc ## Introduction -Marks add new capabilities to tiptap. Marks are like different types of inline styling, for example bold, italic or highlights. +One or multiple marks can be applied to [nodes](/api/nodes), for example to add inline formatting like bold and italic, or other additional information. ## List of supported marks | Title | Default Extension | Source Code | diff --git a/docs/src/docPages/api/nodes.md b/docs/src/docPages/api/nodes.md index f2b693351..524ac380c 100644 --- a/docs/src/docPages/api/nodes.md +++ b/docs/src/docPages/api/nodes.md @@ -3,7 +3,7 @@ ## toc ## Introduction -Nodes add new capabilities to tiptap. Nodes are like block types, for example a paragraph, heading, or code block. +If you think of the document as a tree, then nodes are just a type of content in that tree. Examples of nodes are paragraphs, headings, or code blocks. But nodes don’t have to be blocks. They can also be rendered inline with the text, for example for **@mentions**. ## List of supported nodes | Title | Default Extension | Source Code | diff --git a/docs/src/docPages/examples/code-block-language.md b/docs/src/docPages/examples/syntax-highlighting.md similarity index 66% rename from docs/src/docPages/examples/code-block-language.md rename to docs/src/docPages/examples/syntax-highlighting.md index bdac1b355..03b9598ad 100644 --- a/docs/src/docPages/examples/code-block-language.md +++ b/docs/src/docPages/examples/syntax-highlighting.md @@ -1,3 +1,3 @@ -# Code block language +# Syntax highlighting diff --git a/docs/src/links.yaml b/docs/src/links.yaml index 33f95d429..27fe1fd28 100644 --- a/docs/src/links.yaml +++ b/docs/src/links.yaml @@ -37,7 +37,6 @@ # skip: true - title: Alpine.js link: /installation/alpine - type: new skip: true - title: Livewire link: /installation/livewire @@ -64,7 +63,6 @@ link: /examples/markdown-shortcuts - title: Menus link: /examples/menus - type: new - title: Tables link: /examples/tables # type: pro @@ -86,8 +84,8 @@ link: /examples/savvy - title: Interactivity link: /examples/interactivity - - title: Code block language - link: /examples/code-block-language + - title: Syntax highlighting + link: /examples/syntax-highlighting type: new - title: Guide @@ -96,7 +94,6 @@ link: /guide/configuration - title: Menus link: /guide/menus - type: new - title: Styling link: /guide/styling - title: Output @@ -112,14 +109,11 @@ link: /guide/extend-extensions - title: Interactive node views link: /guide/node-views - type: new items: - title: With JavaScript link: /guide/node-views/js - type: new - title: With React link: /guide/node-views/react - type: new - title: With Vue link: /guide/node-views/vue - title: A few examples From ef6bf3616ebf7e8097ce4a304aa822de6a44bd36 Mon Sep 17 00:00:00 2001 From: Hans Pagel Date: Thu, 15 Apr 2021 19:34:05 +0200 Subject: [PATCH 15/17] docs: add a word break experiment --- .../src/demos/Experiments/WordBreak/index.vue | 69 ++++++++++++++++++ .../demos/Experiments/WordBreak/word-break.ts | 71 +++++++++++++++++++ docs/src/docPages/experiments.md | 1 + docs/src/docPages/experiments/word-break.md | 5 ++ 4 files changed, 146 insertions(+) create mode 100644 docs/src/demos/Experiments/WordBreak/index.vue create mode 100644 docs/src/demos/Experiments/WordBreak/word-break.ts create mode 100644 docs/src/docPages/experiments/word-break.md diff --git a/docs/src/demos/Experiments/WordBreak/index.vue b/docs/src/demos/Experiments/WordBreak/index.vue new file mode 100644 index 000000000..047debd0a --- /dev/null +++ b/docs/src/demos/Experiments/WordBreak/index.vue @@ -0,0 +1,69 @@ + + + + + diff --git a/docs/src/demos/Experiments/WordBreak/word-break.ts b/docs/src/demos/Experiments/WordBreak/word-break.ts new file mode 100644 index 000000000..692ebe047 --- /dev/null +++ b/docs/src/demos/Experiments/WordBreak/word-break.ts @@ -0,0 +1,71 @@ +import { Command, Node, mergeAttributes } from '@tiptap/core' +import { exitCode } from 'prosemirror-commands' + +export interface WordBreakOptions { + HTMLAttributes: { + [key: string]: any + }, +} + +declare module '@tiptap/core' { + interface Commands { + wordBreak: { + /** + * Add a hard break + */ + setWordBreak: () => Command, + } + } +} + +export const WordBreak = Node.create({ + name: 'wordBreak', + + defaultOptions: { + HTMLAttributes: {}, + }, + + inline: true, + + group: 'inline', + + selectable: false, + + parseHTML() { + return [ + { tag: 'wbr' }, + ] + }, + + renderHTML({ HTMLAttributes }) { + return ['wbr', mergeAttributes(this.options.HTMLAttributes, HTMLAttributes)] + }, + + addCommands() { + return { + setWordBreak: () => ({ commands, state, dispatch }) => { + return commands.first([ + () => exitCode(state, dispatch), + () => { + if (dispatch) { + state.tr.replaceSelectionWith(this.type.create()).scrollIntoView() + } + + return true + }, + ]) + }, + } + }, + + addNodeView() { + return () => { + const dom = document.createElement('span') + dom.classList.add('word-break') + + return { + dom, + } + } + }, +}) diff --git a/docs/src/docPages/experiments.md b/docs/src/docPages/experiments.md index 0e9a9acda..33957c718 100644 --- a/docs/src/docPages/experiments.md +++ b/docs/src/docPages/experiments.md @@ -9,3 +9,4 @@ Congratulations! You’ve found our playground with a list of experiments. Be aw * [@tiptap/extension-iframe?](/experiments/embeds) * [@tiptap/extension-toggle-list?](/experiments/details) * [@tiptap/extension-collaboration-annotation](/experiments/collaboration-annotation) +* [@tiptap/extension-word-break](/experiments/word-break) diff --git a/docs/src/docPages/experiments/word-break.md b/docs/src/docPages/experiments/word-break.md new file mode 100644 index 000000000..2f8909cad --- /dev/null +++ b/docs/src/docPages/experiments/word-break.md @@ -0,0 +1,5 @@ +# Word break + +⚠️ Experiment + + From 680ce9b7aa3c0e01a8648a72f4009c7454354401 Mon Sep 17 00:00:00 2001 From: Hans Pagel Date: Thu, 15 Apr 2021 19:50:42 +0200 Subject: [PATCH 16/17] docs: update content --- docs/src/links.yaml | 9 ++++----- docs/src/pages/index.vue | 2 +- 2 files changed, 5 insertions(+), 6 deletions(-) diff --git a/docs/src/links.yaml b/docs/src/links.yaml index 27fe1fd28..3f53cb0a4 100644 --- a/docs/src/links.yaml +++ b/docs/src/links.yaml @@ -30,7 +30,6 @@ skip: true - title: Svelte link: /installation/svelte - type: new skip: true # - title: CodeSandbox # link: /installation/codesandbox @@ -38,10 +37,10 @@ - title: Alpine.js link: /installation/alpine skip: true - - title: Livewire - link: /installation/livewire - type: draft - skip: true + # - title: Livewire + # link: /installation/livewire + # type: draft + # skip: true - title: Upgrade guide link: /overview/upgrade-guide - title: Become a sponsor diff --git a/docs/src/pages/index.vue b/docs/src/pages/index.vue index 7b11e3523..b307efb51 100644 --- a/docs/src/pages/index.vue +++ b/docs/src/pages/index.vue @@ -6,7 +6,7 @@ The headless editor framework for web artisans.

- tiptap gives you full control about every single aspect of your text editor experience. It’s customizable, comes with a ton of extensions, is open-source, has an extensive documentation, and is simply a joy to use. Join our welcoming community and start building cool things! It’s free. + tiptap gives you full control about every single aspect of your text editor experience. It’s customizable, comes with a ton of extensions, is open-source, has an extensive documentation, and is simply a joy to use. Join our welcoming community and start building cool things!

From accceccd093a70ae67b3135dba4e79af228088c3 Mon Sep 17 00:00:00 2001 From: Hans Pagel Date: Thu, 15 Apr 2021 21:48:19 +0200 Subject: [PATCH 17/17] docs: update content --- .../demos/Examples/Savvy/SmilieReplacer.ts | 245 +++++++++--------- docs/src/demos/Examples/Tasks/index.vue | 2 +- docs/src/docPages/advanced-example.md | 5 - docs/src/docPages/api/editor.md | 2 + .../api/{concept.md => introduction.md} | 25 +- docs/src/docPages/api/nodes/emoji.md | 2 +- docs/src/docPages/api/nodes/hashtag.md | 2 +- docs/src/docPages/api/nodes/mention.md | 2 +- docs/src/docPages/api/nodes/task-item.md | 2 +- docs/src/docPages/api/nodes/task-list.md | 2 +- .../examples/collaborative-editing.md | 8 +- docs/src/docPages/examples/images.md | 2 +- docs/src/docPages/examples/interactivity.md | 5 + docs/src/docPages/guide/accessibility.md | 2 +- .../docPages/guide/collaborative-editing.md | 2 +- docs/src/docPages/guide/menus.md | 2 +- docs/src/docPages/guide/node-views/js.md | 2 +- docs/src/docPages/guide/node-views/react.md | 2 +- docs/src/docPages/guide/node-views/vue.md | 2 +- docs/src/docPages/guide/output.md | 8 +- docs/src/docPages/guide/typescript.md | 2 +- docs/src/docPages/installation.md | 18 +- docs/src/docPages/introduction.md | 6 +- docs/src/docPages/overview/contributing.md | 4 - docs/src/docPages/overview/upgrade-guide.md | 3 + docs/src/docPages/reports.md | 12 - docs/src/docPages/sponsor.md | 11 +- docs/src/links.yaml | 24 +- docs/src/pages/index.vue | 4 +- packages/core/README.md | 2 +- packages/extension-blockquote/README.md | 2 +- packages/extension-bold/README.md | 2 +- packages/extension-bubble-menu/README.md | 2 +- packages/extension-bullet-list/README.md | 2 +- packages/extension-character-count/README.md | 2 +- .../extension-code-block-lowlight/README.md | 2 +- packages/extension-code-block/README.md | 2 +- packages/extension-code/README.md | 2 +- .../extension-collaboration-cursor/README.md | 2 +- packages/extension-collaboration/README.md | 2 +- packages/extension-document/README.md | 2 +- packages/extension-dropcursor/README.md | 2 +- packages/extension-floating-menu/README.md | 2 +- packages/extension-focus/README.md | 2 +- packages/extension-font-family/README.md | 2 +- packages/extension-gapcursor/README.md | 2 +- packages/extension-hard-break/README.md | 2 +- packages/extension-heading/README.md | 2 +- packages/extension-highlight/README.md | 2 +- packages/extension-history/README.md | 2 +- packages/extension-horizontal-rule/README.md | 2 +- packages/extension-image/README.md | 2 +- packages/extension-italic/README.md | 2 +- packages/extension-link/README.md | 2 +- packages/extension-list-item/README.md | 2 +- packages/extension-mention/README.md | 2 +- packages/extension-ordered-list/README.md | 2 +- packages/extension-paragraph/README.md | 2 +- packages/extension-placeholder/README.md | 2 +- packages/extension-strike/README.md | 2 +- packages/extension-table-cell/README.md | 2 +- packages/extension-table-header/README.md | 2 +- packages/extension-table-row/README.md | 2 +- packages/extension-table/README.md | 2 +- packages/extension-task-item/README.md | 2 +- packages/extension-task-list/README.md | 2 +- packages/extension-text-align/README.md | 2 +- packages/extension-text-style/README.md | 2 +- packages/extension-text/README.md | 2 +- packages/extension-typography/README.md | 2 +- packages/extension-underline/README.md | 2 +- packages/html/README.md | 2 +- packages/react/README.md | 2 +- packages/starter-kit/README.md | 2 +- packages/suggestion/README.md | 2 +- packages/vue-2/README.md | 2 +- packages/vue-3/README.md | 2 +- 77 files changed, 240 insertions(+), 264 deletions(-) delete mode 100644 docs/src/docPages/advanced-example.md rename docs/src/docPages/api/{concept.md => introduction.md} (78%) delete mode 100644 docs/src/docPages/reports.md diff --git a/docs/src/demos/Examples/Savvy/SmilieReplacer.ts b/docs/src/demos/Examples/Savvy/SmilieReplacer.ts index a17cb9cb1..35fd8e2ae 100644 --- a/docs/src/demos/Examples/Savvy/SmilieReplacer.ts +++ b/docs/src/demos/Examples/Savvy/SmilieReplacer.ts @@ -6,128 +6,129 @@ export const SmilieReplacer = Extension.create({ addInputRules() { return [ - new InputRule(/-___-/, '😑'), - new InputRule(/:'-\)/, '😂'), - new InputRule(/':-\)/, '😅'), - new InputRule(/':-D/, '😅'), - new InputRule(/>:-\)/, '😆'), - new InputRule(/-__-/, '😑'), - new InputRule(/':-\(/, '😓'), - new InputRule(/:'-\(/, '😢'), - new InputRule(/>:-\(/, '😠'), - new InputRule(/O:-\)/, '😇'), - new InputRule(/0:-3/, '😇'), - new InputRule(/0:-\)/, '😇'), - new InputRule(/0;\^\)/, '😇'), - new InputRule(/O;-\)/, '😇'), - new InputRule(/0;-\)/, '😇'), - new InputRule(/O:-3/, '😇'), - new InputRule(/:'\)/, '😂'), - new InputRule(/:-D/, '😃'), - new InputRule(/':\)/, '😅'), - new InputRule(/'=\)/, '😅'), - new InputRule(/':D/, '😅'), - new InputRule(/'=D/, '😅'), - new InputRule(/>:\)/, '😆'), - new InputRule(/>;\)/, '😆'), - new InputRule(/>=\)/, '😆'), - new InputRule(/;-\)/, '😉'), - new InputRule(/\*-\)/, '😉'), - new InputRule(/;-\]/, '😉'), - new InputRule(/;\^\)/, '😉'), - new InputRule(/B-\)/, '😎'), - new InputRule(/8-\)/, '😎'), - new InputRule(/B-D/, '😎'), - new InputRule(/8-D/, '😎'), - new InputRule(/:-\*/, '😘'), - new InputRule(/:\^\*/, '😘'), - new InputRule(/:-\)/, '🙂'), - new InputRule(/-_-/, '😑'), - new InputRule(/:-X/, '😶'), - new InputRule(/:-#/, '😶'), - new InputRule(/:-x/, '😶'), - new InputRule(/>.:O/, '😮'), - new InputRule(/:-P/, '😛'), - new InputRule(/:-p/, '😛'), - new InputRule(/:-Þ/, '😛'), - new InputRule(/:-þ/, '😛'), - new InputRule(/:-b/, '😛'), - new InputRule(/>:P/, '😜'), - new InputRule(/X-P/, '😜'), - new InputRule(/x-p/, '😜'), - new InputRule(/':\(/, '😓'), - new InputRule(/'=\(/, '😓'), - new InputRule(/>:\\/, '😕'), - new InputRule(/>:\//, '😕'), - new InputRule(/:-\//, '😕'), - new InputRule(/:-./, '😕'), - new InputRule(/>:\[/, '😞'), - new InputRule(/:-\(/, '😞'), - new InputRule(/:-\[/, '😞'), - new InputRule(/:'\(/, '😢'), - new InputRule(/;-\(/, '😢'), - new InputRule(/#-\)/, '😵'), - new InputRule(/%-\)/, '😵'), - new InputRule(/X-\)/, '😵'), - new InputRule(/>:\(/, '😠'), - new InputRule(/0:3/, '😇'), - new InputRule(/0:\)/, '😇'), - new InputRule(/O:\)/, '😇'), - new InputRule(/O=\)/, '😇'), - new InputRule(/O:3/, '😇'), - new InputRule(/<\/3/, '💔'), - new InputRule(/:D/, '😃'), - new InputRule(/=D/, '😃'), - new InputRule(/;\)/, '😉'), - new InputRule(/\*\)/, '😉'), - new InputRule(/;\]/, '😉'), - new InputRule(/;D/, '😉'), - new InputRule(/B\)/, '😎'), - new InputRule(/8\)/, '😎'), - new InputRule(/:\*/, '😘'), - new InputRule(/=\*/, '😘'), - new InputRule(/:\)/, '🙂'), - new InputRule(/=\]/, '🙂'), - new InputRule(/=\)/, '🙂'), - new InputRule(/:\]/, '🙂'), - new InputRule(/:X/, '😶'), - new InputRule(/:#/, '😶'), - new InputRule(/=X/, '😶'), - new InputRule(/=x/, '😶'), - new InputRule(/:x/, '😶'), - new InputRule(/=#/, '😶'), - new InputRule(/:O/, '😮'), - new InputRule(/:o/, '😮'), - new InputRule(/:P/, '😛'), - new InputRule(/=P/, '😛'), - new InputRule(/:p/, '😛'), - new InputRule(/=p/, '😛'), - new InputRule(/:Þ/, '😛'), - new InputRule(/:þ/, '😛'), - new InputRule(/:b/, '😛'), - new InputRule(/d:/, '😛'), - new InputRule(/:\//, '😕'), - new InputRule(/:\\/, '😕'), - new InputRule(/=\//, '😕'), - new InputRule(/=\\/, '😕'), - new InputRule(/:L/, '😕'), - new InputRule(/=L/, '😕'), - new InputRule(/:\(/, '😞'), - new InputRule(/:\[/, '😞'), - new InputRule(/=\(/, '😞'), - new InputRule(/;\(/, '😢'), - new InputRule(/D:/, '😨'), - new InputRule(/:\$/, '😳'), - new InputRule(/=\$/, '😳'), - new InputRule(/#\)/, '😵'), - new InputRule(/%\)/, '😵'), - new InputRule(/X\)/, '😵'), - new InputRule(/:@/, '😠'), - new InputRule(/<3/, '❤️'), + new InputRule(/-___- /, '😑 '), + new InputRule(/:'-\) /, '😂 '), + new InputRule(/':-\) /, '😅 '), + new InputRule(/':-D /, '😅 '), + new InputRule(/>:-\) /, '😆 '), + new InputRule(/-__- /, '😑 '), + new InputRule(/':-\( /, '😓 '), + new InputRule(/:'-\( /, '😢 '), + new InputRule(/>:-\( /, '😠 '), + new InputRule(/O:-\) /, '😇 '), + new InputRule(/0:-3 /, '😇 '), + new InputRule(/0:-\) /, '😇 '), + new InputRule(/0;\^\) /, '😇 '), + new InputRule(/O;-\) /, '😇 '), + new InputRule(/0;-\) /, '😇 '), + new InputRule(/O:-3 /, '😇 '), + new InputRule(/:'\) /, '😂 '), + new InputRule(/:-D /, '😃 '), + new InputRule(/':\) /, '😅 '), + new InputRule(/'=\) /, '😅 '), + new InputRule(/':D /, '😅 '), + new InputRule(/'=D /, '😅 '), + new InputRule(/>:\) /, '😆 '), + new InputRule(/>;\) /, '😆 '), + new InputRule(/>=\) /, '😆 '), + new InputRule(/;-\) /, '😉 '), + new InputRule(/\*-\) /, '😉 '), + new InputRule(/;-\] /, '😉 '), + new InputRule(/;\^\) /, '😉 '), + new InputRule(/B-\) /, '😎 '), + new InputRule(/8-\) /, '😎 '), + new InputRule(/B-D /, '😎 '), + new InputRule(/8-D /, '😎 '), + new InputRule(/:-\* /, '😘 '), + new InputRule(/:\^\* /, '😘 '), + new InputRule(/:-\) /, '🙂 '), + new InputRule(/-_- /, '😑 '), + new InputRule(/:-X /, '😶 '), + new InputRule(/:-# /, '😶 '), + new InputRule(/:-x /, '😶 '), + new InputRule(/>.< /, '😣 '), + new InputRule(/:-O /, '😮 '), + new InputRule(/:-o /, '😮 '), + new InputRule(/O_O /, '😮 '), + new InputRule(/>:O /, '😮 '), + new InputRule(/:-P /, '😛 '), + new InputRule(/:-p /, '😛 '), + new InputRule(/:-Þ /, '😛 '), + new InputRule(/:-þ /, '😛 '), + new InputRule(/:-b /, '😛 '), + new InputRule(/>:P /, '😜 '), + new InputRule(/X-P /, '😜 '), + new InputRule(/x-p /, '😜 '), + new InputRule(/':\( /, '😓 '), + new InputRule(/'=\( /, '😓 '), + new InputRule(/>:\\ /, '😕 '), + new InputRule(/>:\/ /, '😕 '), + new InputRule(/:-\/ /, '😕 '), + new InputRule(/:-. /, '😕 '), + new InputRule(/>:\[ /, '😞 '), + new InputRule(/:-\( /, '😞 '), + new InputRule(/:-\[ /, '😞 '), + new InputRule(/:'\( /, '😢 '), + new InputRule(/;-\( /, '😢 '), + new InputRule(/#-\) /, '😵 '), + new InputRule(/%-\) /, '😵 '), + new InputRule(/X-\) /, '😵 '), + new InputRule(/>:\( /, '😠 '), + new InputRule(/0:3 /, '😇 '), + new InputRule(/0:\) /, '😇 '), + new InputRule(/O:\) /, '😇 '), + new InputRule(/O=\) /, '😇 '), + new InputRule(/O:3 /, '😇 '), + new InputRule(/<\/3 /, '💔 '), + new InputRule(/:D /, '😃 '), + new InputRule(/=D /, '😃 '), + new InputRule(/;\) /, '😉 '), + new InputRule(/\*\) /, '😉 '), + new InputRule(/;\] /, '😉 '), + new InputRule(/;D /, '😉 '), + new InputRule(/B\) /, '😎 '), + new InputRule(/8\) /, '😎 '), + new InputRule(/:\* /, '😘 '), + new InputRule(/=\* /, '😘 '), + new InputRule(/:\) /, '🙂 '), + new InputRule(/=\] /, '🙂 '), + new InputRule(/=\) /, '🙂 '), + new InputRule(/:\] /, '🙂 '), + new InputRule(/:X /, '😶 '), + new InputRule(/:# /, '😶 '), + new InputRule(/=X /, '😶 '), + new InputRule(/=x /, '😶 '), + new InputRule(/:x /, '😶 '), + new InputRule(/=# /, '😶 '), + new InputRule(/:O /, '😮 '), + new InputRule(/:o /, '😮 '), + new InputRule(/:P /, '😛 '), + new InputRule(/=P /, '😛 '), + new InputRule(/:p /, '😛 '), + new InputRule(/=p /, '😛 '), + new InputRule(/:Þ /, '😛 '), + new InputRule(/:þ /, '😛 '), + new InputRule(/:b /, '😛 '), + new InputRule(/d: /, '😛 '), + new InputRule(/:\/ /, '😕 '), + new InputRule(/:\\ /, '😕 '), + new InputRule(/=\/ /, '😕 '), + new InputRule(/=\\ /, '😕 '), + new InputRule(/:L /, '😕 '), + new InputRule(/=L /, '😕 '), + new InputRule(/:\( /, '😞 '), + new InputRule(/:\[ /, '😞 '), + new InputRule(/=\( /, '😞 '), + new InputRule(/;\( /, '😢 '), + new InputRule(/D: /, '😨 '), + new InputRule(/:\$ /, '😳 '), + new InputRule(/=\$ /, '😳 '), + new InputRule(/#\) /, '😵 '), + new InputRule(/%\) /, '😵 '), + new InputRule(/X\) /, '😵 '), + new InputRule(/:@ /, '😠 '), + new InputRule(/<3 /, '❤️ '), + new InputRule(/\/shrug/, '¯\\_(ツ)_/¯'), ] }, }) diff --git a/docs/src/demos/Examples/Tasks/index.vue b/docs/src/demos/Examples/Tasks/index.vue index dad4df4e0..d7ca5c0b4 100644 --- a/docs/src/demos/Examples/Tasks/index.vue +++ b/docs/src/demos/Examples/Tasks/index.vue @@ -17,7 +17,7 @@ const CustomDocument = Document.extend({ }) const CustomTaskItem = TaskItem.extend({ - content: 'text*', + content: 'inline*', }) export default { diff --git a/docs/src/docPages/advanced-example.md b/docs/src/docPages/advanced-example.md deleted file mode 100644 index b5bffef8c..000000000 --- a/docs/src/docPages/advanced-example.md +++ /dev/null @@ -1,5 +0,0 @@ -# Advanced Example - -Use a custom list of extensions. - - \ No newline at end of file diff --git a/docs/src/docPages/api/editor.md b/docs/src/docPages/api/editor.md index ef527329b..55b55b169 100644 --- a/docs/src/docPages/api/editor.md +++ b/docs/src/docPages/api/editor.md @@ -182,6 +182,8 @@ new Editor({ }) ``` +You can use that to hook into event handlers and pass - for example - a custom paste handler, too. + ### Parse options Passed content is parsed by ProseMirror. To hook into the parsing, you can pass `parseOptions` which are then handled by [ProseMirror](https://prosemirror.net/docs/ref/#model.ParseOptions). diff --git a/docs/src/docPages/api/concept.md b/docs/src/docPages/api/introduction.md similarity index 78% rename from docs/src/docPages/api/concept.md rename to docs/src/docPages/api/introduction.md index d1ba2d09f..081376481 100644 --- a/docs/src/docPages/api/concept.md +++ b/docs/src/docPages/api/introduction.md @@ -1,4 +1,4 @@ -# Concept +# Introduction tiptap is a friendly wrapper around [ProseMirror](https://ProseMirror.net). Although tiptap tries to hide most of the complexity of ProseMirror, it’s built on top of its APIs and we recommend you to read through the [ProseMirror Guide](https://ProseMirror.net/docs/guide/) for advanced usage. ### Structure @@ -13,14 +13,15 @@ Extensions add [nodes](/api/nodes), [marks](/api/marks) and/or [functionalities] ## Vocabulary ProseMirror has its own vocabulary and you’ll stumble upon all those words now and then. Here is a short overview of the most common words we use in the documentation. -| Word | Description | -| ----------- | --------------------------------------------------------------------------------- | -| Schema | Configures the structure your content can have. | -| Document | The actual content in your editor. | -| State | Everything to describe the current content and selection of your editor. | -| Transaction | A change to the state (updated selection, content, …) | -| Extension | Registeres new functionality. | -| Node | Nodes are a type of content, for example a heading or a paragraph. | -| Mark | One or multiple marks can be applied to nodes, for example for inline formatting. | -| Command | Execute an action inside the editor, that somehow changes the state. | -| Decoration | Styling on top of the document, for example to highlight mistakes. | +| Word | Description | +| ----------- | ------------------------------------------------------------------------ | +| Schema | Configures the structure your content can have. | +| Document | The actual content in your editor. | +| State | Everything to describe the current content and selection of your editor. | +| Transaction | A change to the state (updated selection, content, …) | +| Extension | Registeres new functionality. | +| Node | A type of content, for example a heading or a paragraph. | +| Mark | Can be applied to nodes, for example for inline formatting. | +| Command | Execute an action inside the editor, that somehow changes the state. | +| Decoration | Styling on top of the document, for example to highlight mistakes. | + diff --git a/docs/src/docPages/api/nodes/emoji.md b/docs/src/docPages/api/nodes/emoji.md index 730b5ac86..60d84fee0 100644 --- a/docs/src/docPages/api/nodes/emoji.md +++ b/docs/src/docPages/api/nodes/emoji.md @@ -6,7 +6,7 @@ There is no extension or example yet, but it’s definitely on our list to build If you want to give it a shot yourself, you could start altering the [`Mention`](/api/nodes/mention) node. This uses the [`Suggestion`](/api/utilities/suggestion) utility, which should help with an autocomplete and such things. :::pro Fund the development ♥ -We need your support to maintain, update, support and develop tiptap 2. If you’re waiting for this extension, [become a sponsor and fund our work](/sponsor). +We need your support to maintain, update, support and develop tiptap. If you’re waiting for this extension, [become a sponsor and fund our work](/sponsor). ::: ## Bring your own emoji picker diff --git a/docs/src/docPages/api/nodes/hashtag.md b/docs/src/docPages/api/nodes/hashtag.md index 6099f0601..3cb264a1b 100644 --- a/docs/src/docPages/api/nodes/hashtag.md +++ b/docs/src/docPages/api/nodes/hashtag.md @@ -1,7 +1,7 @@ # Hashtag :::pro Fund the development ♥ -We need your support to maintain, update, support and develop tiptap 2. If you’re waiting for this extension, [become a sponsor and fund our work](/sponsor). +We need your support to maintain, update, support and develop tiptap. If you’re waiting for this extension, [become a sponsor and fund our work](/sponsor). ::: TODO diff --git a/docs/src/docPages/api/nodes/mention.md b/docs/src/docPages/api/nodes/mention.md index 4682b87aa..2cd90517f 100644 --- a/docs/src/docPages/api/nodes/mention.md +++ b/docs/src/docPages/api/nodes/mention.md @@ -39,7 +39,7 @@ yarn add @tiptap/vue-2 And yes, we plan to support React, too. Meanwhile, you can roll your own `ReactRenderer`, but don’t forget to share it with the community. -It’s also possible to use plain JavaScript, but that is probably a lot more work. +It’s also possible to use Vanilla JavaScript, but that is probably a lot more work. ## Settings | Option | Type | Default | Description | diff --git a/docs/src/docPages/api/nodes/task-item.md b/docs/src/docPages/api/nodes/task-item.md index 223f33c1f..dd091df77 100644 --- a/docs/src/docPages/api/nodes/task-item.md +++ b/docs/src/docPages/api/nodes/task-item.md @@ -4,7 +4,7 @@ This extension renders a task item list element, which is a `
  • ` tag with a `data-type` attribute set to `taskItem`. It also renders a checkbox inside the list element, which updates a `checked` attribute. -This extension doesn’t require any JavaScript framework, it’s based on plain JavaScript. +This extension doesn’t require any JavaScript framework, it’s based on Vanilla JavaScript. ## Installation ```bash diff --git a/docs/src/docPages/api/nodes/task-list.md b/docs/src/docPages/api/nodes/task-list.md index d59e8a494..519183169 100644 --- a/docs/src/docPages/api/nodes/task-list.md +++ b/docs/src/docPages/api/nodes/task-list.md @@ -2,7 +2,7 @@ [![Version](https://img.shields.io/npm/v/@tiptap/extension-task-list.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-task-list) [![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-task-list.svg)](https://npmcharts.com/compare/@tiptap/extension-task-list?minimal=true) -This extension enables you to use task lists in the editor. They are rendered as `
      `. This implementation doesn’t require any framework, it’s using plain JavaScript only. +This extension enables you to use task lists in the editor. They are rendered as `
        `. This implementation doesn’t require any framework, it’s using Vanilla JavaScript only. Type [ ]  or [x]  at the beginning of a new line and it will magically transform to a task list. diff --git a/docs/src/docPages/examples/collaborative-editing.md b/docs/src/docPages/examples/collaborative-editing.md index da070d6cd..357407199 100644 --- a/docs/src/docPages/examples/collaborative-editing.md +++ b/docs/src/docPages/examples/collaborative-editing.md @@ -22,19 +22,17 @@ 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://hocuspocus.dev/). +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). ::: ```js import { Server } from '@hocuspocus/server' -import { RocksDB } from '@hocuspocus/rocksdb' +import { RocksDB } from '@hocuspocus/extension-rocksdb' const server = Server.configure({ port: 80, extensions: [ - new RocksDB({ - path: './database', - }) + new RocksDB({ path: './database' }), ], }) diff --git a/docs/src/docPages/examples/images.md b/docs/src/docPages/examples/images.md index a3eda52fd..2ef5df7bd 100644 --- a/docs/src/docPages/examples/images.md +++ b/docs/src/docPages/examples/images.md @@ -1,7 +1,7 @@ # Images :::pro Fund the development ♥ -We need your support to maintain, update, support and develop tiptap 2. If you’re hoping for more features related to images, [become a sponsor and fund our work](/sponsor). +We need your support to maintain, update, support and develop tiptap. If you’re hoping for more features related to images, [become a sponsor and fund our work](/sponsor). ::: diff --git a/docs/src/docPages/examples/interactivity.md b/docs/src/docPages/examples/interactivity.md index 9edeea16d..20f4c15d4 100644 --- a/docs/src/docPages/examples/interactivity.md +++ b/docs/src/docPages/examples/interactivity.md @@ -6,3 +6,8 @@ Thanks to [node views](/guide/node-views) you can add interactivity to your node Vue: 'Guide/NodeViews/VueComponent', React: 'Guide/NodeViews/ReactComponent', }" /> + + diff --git a/docs/src/docPages/guide/accessibility.md b/docs/src/docPages/guide/accessibility.md index 7c2cb15c4..9c00802b1 100644 --- a/docs/src/docPages/guide/accessibility.md +++ b/docs/src/docPages/guide/accessibility.md @@ -1,7 +1,7 @@ # Accessibility :::pro Fund the development ♥ -We need your support to maintain, update, support and develop tiptap 2. If you’re waiting for progress here, [become a sponsor and fund our work](/sponsor). +We need your support to maintain, update, support and develop tiptap. If you’re waiting for progress here, [become a sponsor and fund our work](/sponsor). ::: ## toc diff --git a/docs/src/docPages/guide/collaborative-editing.md b/docs/src/docPages/guide/collaborative-editing.md index 2df83f57e..2f2f8f21e 100644 --- a/docs/src/docPages/guide/collaborative-editing.md +++ b/docs/src/docPages/guide/collaborative-editing.md @@ -216,7 +216,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://hocuspocus.dev/). +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). ::: ### The document name diff --git a/docs/src/docPages/guide/menus.md b/docs/src/docPages/guide/menus.md index c7dacc3eb..0d9b9e41c 100644 --- a/docs/src/docPages/guide/menus.md +++ b/docs/src/docPages/guide/menus.md @@ -111,7 +111,7 @@ This section needs some work. Do you know what else needs to be taken into accou ::: ### Icons -Most editor menus use icons for their buttons. In some of our demos, we use the open-source icon set [Remix Icon](https://remixicon.com/), that’s free to use. But it’s totally up to you what you use. Here are a few icon sets you can consider: +Most editor menus use icons for their buttons. In some of our demos, we use the open source icon set [Remix Icon](https://remixicon.com/), that’s free to use. But it’s totally up to you what you use. Here are a few icon sets you can consider: * [Remix Icon](https://remixicon.com/#editor) * [Font Awesome](https://fontawesome.com/icons?c=editors) diff --git a/docs/src/docPages/guide/node-views/js.md b/docs/src/docPages/guide/node-views/js.md index 6b734b937..2a7a11538 100644 --- a/docs/src/docPages/guide/node-views/js.md +++ b/docs/src/docPages/guide/node-views/js.md @@ -3,7 +3,7 @@ ## toc ## Introduction -Using frameworks like Vue or React can feel too complex, if you’re used to work without those two. Good news: You can use plain JavaScript in your node views. There is just a little bit you need to know, but let’s go through this one by one. +Using frameworks like Vue or React can feel too complex, if you’re used to work without those two. Good news: You can use Vanilla JavaScript in your node views. There is just a little bit you need to know, but let’s go through this one by one. ## Render a node view with JavaScript Here is what you need to do to render a node view inside your editor: diff --git a/docs/src/docPages/guide/node-views/react.md b/docs/src/docPages/guide/node-views/react.md index 0605ff297..ba224d96f 100644 --- a/docs/src/docPages/guide/node-views/react.md +++ b/docs/src/docPages/guide/node-views/react.md @@ -3,7 +3,7 @@ ## toc ## Introduction -Using plain JavaScript can feel complex if you are used to work in React. Good news: You can use regular React components in your node views, too. There is just a little bit you need to know, but let’s go through this one by one. +Using Vanilla JavaScript can feel complex if you are used to work in React. Good news: You can use regular React components in your node views, too. There is just a little bit you need to know, but let’s go through this one by one. ## Render a React component Here is what you need to do to render React components inside your editor: diff --git a/docs/src/docPages/guide/node-views/vue.md b/docs/src/docPages/guide/node-views/vue.md index 9d97df26e..55791b5fe 100644 --- a/docs/src/docPages/guide/node-views/vue.md +++ b/docs/src/docPages/guide/node-views/vue.md @@ -3,7 +3,7 @@ ## toc ## Introduction -Using plain JavaScript can feel complex if you are used to work in Vue. Good news: You can use regular Vue components in your node views, too. There is just a little bit you need to know, but let’s go through this one by one. +Using Vanilla JavaScript can feel complex if you are used to work in Vue. Good news: You can use regular Vue components in your node views, too. There is just a little bit you need to know, but let’s go through this one by one. ## Render a Vue component Here is what you need to do to render Vue components inside your editor: diff --git a/docs/src/docPages/guide/output.md b/docs/src/docPages/guide/output.md index 1d53f1d32..39b0772cd 100644 --- a/docs/src/docPages/guide/output.md +++ b/docs/src/docPages/guide/output.md @@ -67,7 +67,7 @@ Use this interactive example to fiddle around: ### Option 3: Y.js -Our editor has amazing support for Y.js, which is amazing to add [realtime collaboration, offline editing, or syncing between devices](/guide/collaborative-editing). +Our editor has top notch support for Y.js, which is amazing to add features like [realtime collaboration, offline editing, or syncing between devices](/guide/collaborative-editing). Internally, Y.js stores a history of all changes. That can be in the browser, on a server, synced with other connected clients, or on a USB stick. But, it’s important to know that Y.js needs those stored changes. A simple JSON document is not enough to merge changes. @@ -79,13 +79,13 @@ That said, it’s amazing and we’re about to provide an amazing backend, that Unfortunately, **tiptap doesn’t support Markdown as an input or output format**. We considered to add support for it, but those are the reasons why we decided to not do it: * Both, HTML and JSON, can have deeply nested structures, Markdown is flat. -* There are enough packages to convert HTML to Markdown and vice-versa. * Markdown standards vary. * tiptap’s strength is cutomization, that doesn’t work very well with Markdown. +* There are enough packages to convert HTML to Markdown and vice-versa. You should really consider to work with HTML or JSON to store your content, they are perfectly fine for most use cases. -If you still think you need Markdown, ProseMirror has an [example on how to deal with Markdown](https://prosemirror.net/examples/markdown/), [Nextcloud Text](https://github.com/nextcloud/text) uses tiptap 1 to work with Markdown. Maybe you can learn from them. Or if you’re looking for a really good Markdown editor, try [CodeMirror](https://codemirror.net/). +If you still think you need Markdown, ProseMirror has an [example on how to deal with Markdown](https://prosemirror.net/examples/markdown/), [Nextcloud Text](https://github.com/nextcloud/text) uses tiptap 1 to work with Markdown. Maybe you can learn from them. Or if you are looking for a really good Markdown editor, try [CodeMirror](https://codemirror.net/). That said, tiptap does support [Markdown shortcuts](/examples/markdown-shortcuts) to format your content. Also you’re free to let your content look like Markdown, for example add a `#` before an `

        ` with CSS. @@ -127,4 +127,4 @@ We’re about to go through a few cases to help with that, for example we provid [Share your experiences with us!](mailto:humans@tiptap.dev) We’d like to add more information here. ## Security -There’s no reason to use on or the other because of security concerns. If someone wants to send malicious content to your server, it doesn’t matter if it’s JSON or HTML. You should always validate user input. +There is no reason to use on or the other because of security concerns. If someone wants to send malicious content to your server, it doesn’t matter if it’s JSON or HTML. It doesn’t even matter if you’re using tiptap or not. You should always validate user input. diff --git a/docs/src/docPages/guide/typescript.md b/docs/src/docPages/guide/typescript.md index bb04e63b8..c0b2c00e5 100644 --- a/docs/src/docPages/guide/typescript.md +++ b/docs/src/docPages/guide/typescript.md @@ -5,7 +5,7 @@ ## Introduction The whole tiptap is code base is written in TypeScript. If you haven’t heard of it or never used it, no worries. You don’t have to. -TypeScript extends JavaScript by adding types (hence the name). It adds new syntax, which doesn’t exist in plain JavaScript. It’s actually removed before running in the browser, but this step – the compilation – is important to find bugs early. It checks if you passe the right types of data to functions. For a big and complex project, that’s very valuable. It means we’ll get notified of lot of bugs, before shipping code to you. +TypeScript extends JavaScript by adding types (hence the name). It adds new syntax, which doesn’t exist in Vanilla JavaScript. It’s actually removed before running in the browser, but this step – the compilation – is important to find bugs early. It checks if you passe the right types of data to functions. For a big and complex project, that’s very valuable. It means we’ll get notified of lot of bugs, before shipping code to you. **Anyway, if you don’t use TypeScript in your project, that’s fine.** You will still be able to use tiptap and nevertheless get a nice autocomplete for the tiptap API (if your editor supports it, but most do). diff --git a/docs/src/docPages/installation.md b/docs/src/docPages/installation.md index 5463f7b71..c21ba9ac1 100644 --- a/docs/src/docPages/installation.md +++ b/docs/src/docPages/installation.md @@ -3,17 +3,17 @@ ## toc ## Introduction -tiptap 2 is framework-agnostic and even works with plain JavaScript, if that’s your thing. We’re working on guides for all the different frameworks and workflows. The following steps should help you to integrate tiptap in your JavaScript project. +tiptap is framework-agnostic and even works with Vanilla JavaScript, if that’s your thing. The following integration guides should help you to integrate tiptap in your JavaScript project. ## Integration guides * [CDN](/installation/cdn) -* [CodeSandbox](/installation/codesandbox) -* [Vue 2](/installation/vue2) + +* [React](/installation/react) * [Vue 3](/installation/vue3) +* [Vue 2](/installation/vue2) * [Nuxt.js](/installation/nuxt) -* [React](/installation/react) (Draft) -* [Svelte](/installation/svelte) (Draft) -* [Alpine.js](/installation/alpine) (Draft) +* [Svelte](/installation/svelte) +* [Alpine.js](/installation/alpine) * [Livewire](/installation/livewire) (Draft) ## Vanilla JavaScript @@ -22,7 +22,7 @@ tiptap 2 is framework-agnostic and even works with plain JavaScript, if that’s * [Node](https://nodejs.org/en/download/) installed on your machine ### 1. Install the dependencies -For the following example you will need `@tiptap/core` (the actual editor) and `@tiptap/starter-kit` which has everything to get started quickly, for example the most common extensions. +For the following example you will need `@tiptap/core` (the actual editor) and `@tiptap/starter-kit` which has the most common extensions to get started quickly. ```bash # install with npm @@ -40,7 +40,7 @@ Add the following HTML where you want the editor to be mounted: ``` ### 3. Initialize the editor -Now, let’s initialize the editor in JavaScript: +Let’s initialize the editor in JavaScript now: ```js import { Editor } from '@tiptap/core' @@ -53,4 +53,4 @@ new Editor({ }) ``` -Open your project in the browser and you should see tiptap. Good work! Time to give yourself a pat on the back. +Open your project in the browser to see tiptap in action. Good work! Time to give yourself a pat on the back. diff --git a/docs/src/docPages/introduction.md b/docs/src/docPages/introduction.md index 77e55a9b2..eda3c5496 100644 --- a/docs/src/docPages/introduction.md +++ b/docs/src/docPages/introduction.md @@ -10,7 +10,7 @@ title: Headless WYSIWYG Text Editor tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a toolkit for building rich text WYSIWYG editors, which is already in use at many well-known companies such as *New York Times*, *The Guardian* or *Atlassian*. -Create exactly the rich text editor you want out of customizable building blocks. tiptap comes with sensible defaults, a lot of extensions and a friendly API to customize every aspect. It’s backed by a welcoming community, open-source, and free. +Create exactly the rich text editor you want out of customizable building blocks. tiptap comes with sensible defaults, a lot of extensions and a friendly API to customize every aspect. It’s backed by a welcoming community, open source, and free. ## Example @@ -18,9 +18,9 @@ Create exactly the rich text editor you want out of customizable building blocks ## Features **Headless.** We don’t tell you what a menu should look like or where it should be rendered in the DOM. That’s why tiptap is headless and comes without any CSS. You are in full control over markup, styling and behaviour. -**Framework-agnostic.** No matter what framework you use, you’ll enjoy tiptap. Out of the box, it works with plain JavaScript and Vue.js, but it’s also possible to use it in [React](/installation/react), Svelte and others. +**Framework-agnostic.** No matter what framework you use, you’ll enjoy tiptap. Out of the box, it works with Vanilla JavaScript and Vue.js, but it’s also possible to use it in [React](/installation/react), Svelte and others. -**TypeScript.** tiptap 2 is written in TypeScript. That helps us to find bugs early and gives you a nice autocomplete for the API (if your IDE supports that) on top of the extensive human written documentation. +**TypeScript.** tiptap is written in TypeScript. That helps us to find bugs early and gives you a nice autocomplete for the API (if your IDE supports that) on top of the extensive human written documentation. **Collaborative.** Real-time collaboration, syncing between different devices and working offline used to be hard. We provide everything you need to keep everything in sync, conflict-free with the power of [Y.js](https://github.com/yjs/yjs). Our production-grade setup requires less than 20 lines of code. diff --git a/docs/src/docPages/overview/contributing.md b/docs/src/docPages/overview/contributing.md index b38c0c8a4..bd35b8f18 100644 --- a/docs/src/docPages/overview/contributing.md +++ b/docs/src/docPages/overview/contributing.md @@ -5,10 +5,6 @@ ## Introduction 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: -:::warning Private repository -Currently, the repository is private. That means PRs are disabled, too. We’ll release a public version of tiptap 2 soonish, please wait with your PRs until the repository is public. -::: - ## Welcome examples * Failing regression tests as bug reports * Documentation improvements, e. g. fix a typo, add a section diff --git a/docs/src/docPages/overview/upgrade-guide.md b/docs/src/docPages/overview/upgrade-guide.md index 39f557b22..c0491f490 100644 --- a/docs/src/docPages/overview/upgrade-guide.md +++ b/docs/src/docPages/overview/upgrade-guide.md @@ -172,6 +172,9 @@ The reference implementation for collaborative editing uses Y.js now. That’s a Read more about [the new collaborative editing experience](/guide/collaborative-editing) in our guide. +### Marks don’t support node view anymore +For marks, node views are [not well supported in ProseMirror](https://discuss.prosemirror.net/t/there-is-a-bug-in-marks-nodeview/2722/2). There is also [a related issue](https://github.com/ueberdosis/tiptap/issues/613) for tiptap 1. That’s why we removed it in tiptap 2. + ### Become a sponsor tiptap wouldn’t exist without the funding of its community. If you fell in love with tiptap, don’t forget to [become a sponsor](/sponsor) and make the maintenance, development and support sustainable. diff --git a/docs/src/docPages/reports.md b/docs/src/docPages/reports.md deleted file mode 100644 index 92151a906..000000000 --- a/docs/src/docPages/reports.md +++ /dev/null @@ -1,12 +0,0 @@ -# Monthly reports - -| Month | Tasks | Sponsors | Funding | Worked | -| --------- | ---------------------------------------------------------------------- | -------- | ------- | ------------- | -| 01/2021 | Maintenance tiptap v1, … | … | … | … | -| 12/2020 | Invited all sponsors, gathered feedback | 60 | $1,035 | 60 h | -| 11/2020 | Wrote documentation, improved collaborative editing, advanced examples | 31 | $468 | 188 h | -| 10/2020 | Rewrote extensions for tiptap 2 | 25 | $423 | 102 h | -| 09/2020 | Developed the new API, wrote documentation | | | 125 h | -| 08/2020 | Set up tiptap 2 | | | 56 h | -| **Total** | | | | **531 h** | - diff --git a/docs/src/docPages/sponsor.md b/docs/src/docPages/sponsor.md index 22fb90b3d..25be5551f 100644 --- a/docs/src/docPages/sponsor.md +++ b/docs/src/docPages/sponsor.md @@ -3,21 +3,20 @@ ## 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)! ♥ +Give back to the open source community and [sponsor us on GitHub](https://github.com/sponsors/ueberdosis)! ♥ ## Your benefits as a sponsor -* Give back to the open-source community * Get early access to private repositories -* Ensure the further maintenace and development of tiptap * Your issues and pull requests get a `sponsor ♥` label * Get a sponsor badge in all your comments on GitHub +* Invest in the future of tiptap +* Give back to the open source community * Show support in your GitHub profile -* Receive monthly reports about our open-source work -Does that sound good? [Sponsor us on GitHub!](https://github.com/sponsors/ueberdosis) +Sounds good? [Sponsor us on GitHub!](https://github.com/sponsors/ueberdosis) ## The maintainers of tiptap -If you’re thankful for tiptap, you should say thank you to all 12 lovely people of [überdosis](https://twitter.com/_ueberdosis). The amazing company we’re all building together and the amazing company that funded the initial development costs of tiptap 2. +If you are thankful for tiptap, you should say thank you to the lovely people of [überdosis](https://twitter.com/_ueberdosis). The amazing company we are all building together and the amazing company that funded the initial development costs of tiptap. AND you should definitely hire us if you want us to design und build an amazing digital product for you. Bonus points if it’s somehow text editing related. diff --git a/docs/src/links.yaml b/docs/src/links.yaml index 3f53cb0a4..e09b32e25 100644 --- a/docs/src/links.yaml +++ b/docs/src/links.yaml @@ -57,14 +57,12 @@ link: /examples/default - title: Collaborative editing link: /examples/collaborative-editing - # type: pro - title: Markdown shortcuts link: /examples/markdown-shortcuts - title: Menus link: /examples/menus - title: Tables link: /examples/tables - # type: pro - title: Images link: /examples/images - title: Formatting @@ -101,7 +99,6 @@ link: /guide/accessibility - title: Collaborative editing link: /guide/collaborative-editing - # type: pro - title: Custom extensions link: /guide/custom-extensions - title: Overwrite & extend @@ -122,8 +119,8 @@ - title: API items: - - title: Concept - link: /api/concept + - title: Introduction + link: /api/introduction - title: Editor link: /api/editor - title: Commands @@ -178,16 +175,12 @@ link: /api/nodes/paragraph - title: Table link: /api/nodes/table - # type: pro - title: TableRow link: /api/nodes/table-row - # type: pro - title: TableCell link: /api/nodes/table-cell - # type: pro - title: TableHeader link: /api/nodes/table-header - # type: pro - title: TaskList link: /api/nodes/task-list - title: TaskItem @@ -216,9 +209,6 @@ - title: Extensions link: /api/extensions items: - # - title: Annotation - # link: /api/extensions/annotation - # type: draft - title: BubbleMenu link: /api/extensions/bubble-menu type: new @@ -226,10 +216,8 @@ link: /api/extensions/character-count - title: Collaboration link: /api/extensions/collaboration - # type: pro - title: CollaborationCursor link: /api/extensions/collaboration-cursor - # type: pro - title: Dropcursor link: /api/extensions/dropcursor - title: FloatingMenu @@ -258,9 +246,9 @@ link: /api/utilities/html - title: Suggestion link: /api/utilities/suggestion - - title: Events - link: /api/events - - title: Schema - link: /api/schema - title: Keyboard shortcuts link: /api/keyboard-shortcuts + - title: Schema + link: /api/schema + - title: Events + link: /api/events diff --git a/docs/src/pages/index.vue b/docs/src/pages/index.vue index b307efb51..ae5e03595 100644 --- a/docs/src/pages/index.vue +++ b/docs/src/pages/index.vue @@ -6,7 +6,7 @@ The headless editor framework for web artisans.

        - tiptap gives you full control about every single aspect of your text editor experience. It’s customizable, comes with a ton of extensions, is open-source, has an extensive documentation, and is simply a joy to use. Join our welcoming community and start building cool things! + tiptap gives you full control about every single aspect of your text editor experience. It’s customizable, comes with a ton of extensions, is open source, has an extensive documentation, and is simply a joy to use. Join our welcoming community and start building cool things!

        @@ -49,7 +49,7 @@ Framework-agnostic

        - Out of the box, tiptap works with plain JavaScript and Vue.js, but it’s also possible to use it in React, Svelte and others. + Out of the box, tiptap works with Vanilla JavaScript and Vue.js, but it’s also possible to use it in React, Svelte and others.

        diff --git a/packages/core/README.md b/packages/core/README.md index 3aeb96305..6d35ab978 100644 --- a/packages/core/README.md +++ b/packages/core/README.md @@ -11,4 +11,4 @@ tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a Documentation can be found on the [tiptap website](https://tiptap.dev). ## License -tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). +tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). diff --git a/packages/extension-blockquote/README.md b/packages/extension-blockquote/README.md index 51660bd81..af37526aa 100644 --- a/packages/extension-blockquote/README.md +++ b/packages/extension-blockquote/README.md @@ -11,4 +11,4 @@ tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a Documentation can be found on the [tiptap website](https://tiptap.dev). ## License -tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). +tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). diff --git a/packages/extension-bold/README.md b/packages/extension-bold/README.md index ed1b0f9b8..fdc647a3e 100644 --- a/packages/extension-bold/README.md +++ b/packages/extension-bold/README.md @@ -11,4 +11,4 @@ tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a Documentation can be found on the [tiptap website](https://tiptap.dev). ## License -tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). +tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). diff --git a/packages/extension-bubble-menu/README.md b/packages/extension-bubble-menu/README.md index cf61d9fbe..f926a0856 100644 --- a/packages/extension-bubble-menu/README.md +++ b/packages/extension-bubble-menu/README.md @@ -11,4 +11,4 @@ tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a Documentation can be found on the [tiptap website](https://tiptap.dev). ## License -tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). +tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). diff --git a/packages/extension-bullet-list/README.md b/packages/extension-bullet-list/README.md index 1013d24e9..43b6f0363 100644 --- a/packages/extension-bullet-list/README.md +++ b/packages/extension-bullet-list/README.md @@ -11,4 +11,4 @@ tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a Documentation can be found on the [tiptap website](https://tiptap.dev). ## License -tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). +tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). diff --git a/packages/extension-character-count/README.md b/packages/extension-character-count/README.md index 555586c2f..de705600e 100644 --- a/packages/extension-character-count/README.md +++ b/packages/extension-character-count/README.md @@ -11,4 +11,4 @@ tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a Documentation can be found on the [tiptap website](https://tiptap.dev). ## License -tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). +tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). diff --git a/packages/extension-code-block-lowlight/README.md b/packages/extension-code-block-lowlight/README.md index d950097e8..b34306d2e 100644 --- a/packages/extension-code-block-lowlight/README.md +++ b/packages/extension-code-block-lowlight/README.md @@ -11,4 +11,4 @@ tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a Documentation can be found on the [tiptap website](https://tiptap.dev). ## License -tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). +tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). diff --git a/packages/extension-code-block/README.md b/packages/extension-code-block/README.md index bf84f5e1f..acc720d05 100644 --- a/packages/extension-code-block/README.md +++ b/packages/extension-code-block/README.md @@ -11,4 +11,4 @@ tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a Documentation can be found on the [tiptap website](https://tiptap.dev). ## License -tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). +tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). diff --git a/packages/extension-code/README.md b/packages/extension-code/README.md index a5426016d..2f84be8cd 100644 --- a/packages/extension-code/README.md +++ b/packages/extension-code/README.md @@ -11,4 +11,4 @@ tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a Documentation can be found on the [tiptap website](https://tiptap.dev). ## License -tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). +tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). diff --git a/packages/extension-collaboration-cursor/README.md b/packages/extension-collaboration-cursor/README.md index 3bffd3ba1..6051393f9 100644 --- a/packages/extension-collaboration-cursor/README.md +++ b/packages/extension-collaboration-cursor/README.md @@ -11,4 +11,4 @@ tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a Documentation can be found on the [tiptap website](https://tiptap.dev). ## License -tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). +tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). diff --git a/packages/extension-collaboration/README.md b/packages/extension-collaboration/README.md index fb2b8c4d0..774114240 100644 --- a/packages/extension-collaboration/README.md +++ b/packages/extension-collaboration/README.md @@ -11,4 +11,4 @@ tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a Documentation can be found on the [tiptap website](https://tiptap.dev). ## License -tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). +tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). diff --git a/packages/extension-document/README.md b/packages/extension-document/README.md index 2b31a8be0..703f47e42 100644 --- a/packages/extension-document/README.md +++ b/packages/extension-document/README.md @@ -11,4 +11,4 @@ tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a Documentation can be found on the [tiptap website](https://tiptap.dev). ## License -tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). +tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). diff --git a/packages/extension-dropcursor/README.md b/packages/extension-dropcursor/README.md index 98b3bf308..585e676a0 100644 --- a/packages/extension-dropcursor/README.md +++ b/packages/extension-dropcursor/README.md @@ -11,4 +11,4 @@ tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a Documentation can be found on the [tiptap website](https://tiptap.dev). ## License -tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). +tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). diff --git a/packages/extension-floating-menu/README.md b/packages/extension-floating-menu/README.md index 3b68aecc6..42302abff 100644 --- a/packages/extension-floating-menu/README.md +++ b/packages/extension-floating-menu/README.md @@ -11,4 +11,4 @@ tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a Documentation can be found on the [tiptap website](https://tiptap.dev). ## License -tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). +tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). diff --git a/packages/extension-focus/README.md b/packages/extension-focus/README.md index 28fadf680..becb05698 100644 --- a/packages/extension-focus/README.md +++ b/packages/extension-focus/README.md @@ -11,4 +11,4 @@ tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a Documentation can be found on the [tiptap website](https://tiptap.dev). ## License -tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). +tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). diff --git a/packages/extension-font-family/README.md b/packages/extension-font-family/README.md index 0344208be..6f641af36 100644 --- a/packages/extension-font-family/README.md +++ b/packages/extension-font-family/README.md @@ -11,4 +11,4 @@ tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a Documentation can be found on the [tiptap website](https://tiptap.dev). ## License -tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). +tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). diff --git a/packages/extension-gapcursor/README.md b/packages/extension-gapcursor/README.md index d6032fc57..a0d32ba66 100644 --- a/packages/extension-gapcursor/README.md +++ b/packages/extension-gapcursor/README.md @@ -11,4 +11,4 @@ tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a Documentation can be found on the [tiptap website](https://tiptap.dev). ## License -tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). +tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). diff --git a/packages/extension-hard-break/README.md b/packages/extension-hard-break/README.md index 3336aa2eb..a2901a8ed 100644 --- a/packages/extension-hard-break/README.md +++ b/packages/extension-hard-break/README.md @@ -11,4 +11,4 @@ tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a Documentation can be found on the [tiptap website](https://tiptap.dev). ## License -tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). +tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). diff --git a/packages/extension-heading/README.md b/packages/extension-heading/README.md index 8ced227a2..1d461fc6c 100644 --- a/packages/extension-heading/README.md +++ b/packages/extension-heading/README.md @@ -11,4 +11,4 @@ tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a Documentation can be found on the [tiptap website](https://tiptap.dev). ## License -tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). +tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). diff --git a/packages/extension-highlight/README.md b/packages/extension-highlight/README.md index 47de19674..71e4f7cb4 100644 --- a/packages/extension-highlight/README.md +++ b/packages/extension-highlight/README.md @@ -11,4 +11,4 @@ tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a Documentation can be found on the [tiptap website](https://tiptap.dev). ## License -tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). +tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). diff --git a/packages/extension-history/README.md b/packages/extension-history/README.md index 5d668b63f..1672cb727 100644 --- a/packages/extension-history/README.md +++ b/packages/extension-history/README.md @@ -11,4 +11,4 @@ tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a Documentation can be found on the [tiptap website](https://tiptap.dev). ## License -tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). +tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). diff --git a/packages/extension-horizontal-rule/README.md b/packages/extension-horizontal-rule/README.md index b39e3997f..5db0918ff 100644 --- a/packages/extension-horizontal-rule/README.md +++ b/packages/extension-horizontal-rule/README.md @@ -11,4 +11,4 @@ tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a Documentation can be found on the [tiptap website](https://tiptap.dev). ## License -tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). +tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). diff --git a/packages/extension-image/README.md b/packages/extension-image/README.md index 6ca156f94..e9e8416b5 100644 --- a/packages/extension-image/README.md +++ b/packages/extension-image/README.md @@ -11,4 +11,4 @@ tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a Documentation can be found on the [tiptap website](https://tiptap.dev). ## License -tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). +tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). diff --git a/packages/extension-italic/README.md b/packages/extension-italic/README.md index 381133ac2..b1e4fc77b 100644 --- a/packages/extension-italic/README.md +++ b/packages/extension-italic/README.md @@ -11,4 +11,4 @@ tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a Documentation can be found on the [tiptap website](https://tiptap.dev). ## License -tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). +tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). diff --git a/packages/extension-link/README.md b/packages/extension-link/README.md index 0bd71715f..c41bb38dc 100644 --- a/packages/extension-link/README.md +++ b/packages/extension-link/README.md @@ -11,4 +11,4 @@ tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a Documentation can be found on the [tiptap website](https://tiptap.dev). ## License -tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). +tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). diff --git a/packages/extension-list-item/README.md b/packages/extension-list-item/README.md index 66e021b4b..4e7a41628 100644 --- a/packages/extension-list-item/README.md +++ b/packages/extension-list-item/README.md @@ -11,4 +11,4 @@ tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a Documentation can be found on the [tiptap website](https://tiptap.dev). ## License -tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). +tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). diff --git a/packages/extension-mention/README.md b/packages/extension-mention/README.md index e44522989..bc5ff8521 100644 --- a/packages/extension-mention/README.md +++ b/packages/extension-mention/README.md @@ -11,4 +11,4 @@ tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a Documentation can be found on the [tiptap website](https://tiptap.dev). ## License -tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). +tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). diff --git a/packages/extension-ordered-list/README.md b/packages/extension-ordered-list/README.md index 6a2290a8e..bac5901ac 100644 --- a/packages/extension-ordered-list/README.md +++ b/packages/extension-ordered-list/README.md @@ -11,4 +11,4 @@ tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a Documentation can be found on the [tiptap website](https://tiptap.dev). ## License -tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). +tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). diff --git a/packages/extension-paragraph/README.md b/packages/extension-paragraph/README.md index a5a1b8871..cb283dfd1 100644 --- a/packages/extension-paragraph/README.md +++ b/packages/extension-paragraph/README.md @@ -11,4 +11,4 @@ tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a Documentation can be found on the [tiptap website](https://tiptap.dev). ## License -tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). +tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). diff --git a/packages/extension-placeholder/README.md b/packages/extension-placeholder/README.md index 8f7194426..4ea1ffbe0 100644 --- a/packages/extension-placeholder/README.md +++ b/packages/extension-placeholder/README.md @@ -11,4 +11,4 @@ tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a Documentation can be found on the [tiptap website](https://tiptap.dev). ## License -tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). +tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). diff --git a/packages/extension-strike/README.md b/packages/extension-strike/README.md index 386cbbeb9..91f8fb0e5 100644 --- a/packages/extension-strike/README.md +++ b/packages/extension-strike/README.md @@ -11,4 +11,4 @@ tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a Documentation can be found on the [tiptap website](https://tiptap.dev). ## License -tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). +tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). diff --git a/packages/extension-table-cell/README.md b/packages/extension-table-cell/README.md index 8924b07ec..b3713c469 100644 --- a/packages/extension-table-cell/README.md +++ b/packages/extension-table-cell/README.md @@ -11,4 +11,4 @@ tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a Documentation can be found on the [tiptap website](https://tiptap.dev). ## License -tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). +tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). diff --git a/packages/extension-table-header/README.md b/packages/extension-table-header/README.md index 4dba78447..e6f6d1e02 100644 --- a/packages/extension-table-header/README.md +++ b/packages/extension-table-header/README.md @@ -11,4 +11,4 @@ tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a Documentation can be found on the [tiptap website](https://tiptap.dev). ## License -tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). +tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). diff --git a/packages/extension-table-row/README.md b/packages/extension-table-row/README.md index a1249cd8f..03d311ce8 100644 --- a/packages/extension-table-row/README.md +++ b/packages/extension-table-row/README.md @@ -11,4 +11,4 @@ tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a Documentation can be found on the [tiptap website](https://tiptap.dev). ## License -tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). +tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). diff --git a/packages/extension-table/README.md b/packages/extension-table/README.md index 797c9c1b6..d5c0c2e3b 100644 --- a/packages/extension-table/README.md +++ b/packages/extension-table/README.md @@ -11,4 +11,4 @@ tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a Documentation can be found on the [tiptap website](https://tiptap.dev). ## License -tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). +tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). diff --git a/packages/extension-task-item/README.md b/packages/extension-task-item/README.md index c24b10b3c..e4c97f699 100644 --- a/packages/extension-task-item/README.md +++ b/packages/extension-task-item/README.md @@ -11,4 +11,4 @@ tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a Documentation can be found on the [tiptap website](https://tiptap.dev). ## License -tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). +tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). diff --git a/packages/extension-task-list/README.md b/packages/extension-task-list/README.md index a91a9d15c..5ebf181e2 100644 --- a/packages/extension-task-list/README.md +++ b/packages/extension-task-list/README.md @@ -11,4 +11,4 @@ tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a Documentation can be found on the [tiptap website](https://tiptap.dev). ## License -tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). +tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). diff --git a/packages/extension-text-align/README.md b/packages/extension-text-align/README.md index 05c2930c4..3410a73ec 100644 --- a/packages/extension-text-align/README.md +++ b/packages/extension-text-align/README.md @@ -11,4 +11,4 @@ tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a Documentation can be found on the [tiptap website](https://tiptap.dev). ## License -tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). +tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). diff --git a/packages/extension-text-style/README.md b/packages/extension-text-style/README.md index 28e2e2542..f52e2a94d 100644 --- a/packages/extension-text-style/README.md +++ b/packages/extension-text-style/README.md @@ -11,4 +11,4 @@ tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a Documentation can be found on the [tiptap website](https://tiptap.dev). ## License -tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). +tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). diff --git a/packages/extension-text/README.md b/packages/extension-text/README.md index 497cd2cc1..f940da8f1 100644 --- a/packages/extension-text/README.md +++ b/packages/extension-text/README.md @@ -11,4 +11,4 @@ tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a Documentation can be found on the [tiptap website](https://tiptap.dev). ## License -tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). +tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). diff --git a/packages/extension-typography/README.md b/packages/extension-typography/README.md index b6687f0e1..b7b820a8e 100644 --- a/packages/extension-typography/README.md +++ b/packages/extension-typography/README.md @@ -11,4 +11,4 @@ tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a Documentation can be found on the [tiptap website](https://tiptap.dev). ## License -tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). +tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). diff --git a/packages/extension-underline/README.md b/packages/extension-underline/README.md index 858641985..285a1764d 100644 --- a/packages/extension-underline/README.md +++ b/packages/extension-underline/README.md @@ -11,4 +11,4 @@ tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a Documentation can be found on the [tiptap website](https://tiptap.dev). ## License -tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). +tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). diff --git a/packages/html/README.md b/packages/html/README.md index 1b2110544..6d1dee503 100644 --- a/packages/html/README.md +++ b/packages/html/README.md @@ -11,4 +11,4 @@ tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a Documentation can be found on the [tiptap website](https://tiptap.dev). ## License -tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). +tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). diff --git a/packages/react/README.md b/packages/react/README.md index a2dfdd18b..f901f7bf2 100644 --- a/packages/react/README.md +++ b/packages/react/README.md @@ -11,4 +11,4 @@ tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a Documentation can be found on the [tiptap website](https://tiptap.dev). ## License -tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). +tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). diff --git a/packages/starter-kit/README.md b/packages/starter-kit/README.md index 0098a4753..518886922 100644 --- a/packages/starter-kit/README.md +++ b/packages/starter-kit/README.md @@ -11,4 +11,4 @@ tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a Documentation can be found on the [tiptap website](https://tiptap.dev). ## License -tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). +tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). diff --git a/packages/suggestion/README.md b/packages/suggestion/README.md index 22c4be68e..4b5f91eba 100644 --- a/packages/suggestion/README.md +++ b/packages/suggestion/README.md @@ -11,4 +11,4 @@ tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a Documentation can be found on the [tiptap website](https://tiptap.dev). ## License -tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). +tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). diff --git a/packages/vue-2/README.md b/packages/vue-2/README.md index c8ff79fd0..39d410197 100644 --- a/packages/vue-2/README.md +++ b/packages/vue-2/README.md @@ -11,4 +11,4 @@ tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a Documentation can be found on the [tiptap website](https://tiptap.dev). ## License -tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). +tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). diff --git a/packages/vue-3/README.md b/packages/vue-3/README.md index 5bee2004f..0b79b71c1 100644 --- a/packages/vue-3/README.md +++ b/packages/vue-3/README.md @@ -11,4 +11,4 @@ tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a Documentation can be found on the [tiptap website](https://tiptap.dev). ## License -tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md). +tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md).