From 813575850c47b960f8eb2dc7962e319321cf6419 Mon Sep 17 00:00:00 2001 From: Hans Pagel Date: Fri, 13 Nov 2020 10:51:53 +0100 Subject: [PATCH 1/2] update content --- docs/src/demos/Examples/Links/index.vue | 8 +---- .../Examples/{FullEditor => VModel}/index.vue | 0 docs/src/docPages/examples/full-editor.md | 3 -- docs/src/docPages/examples/v-model.md | 3 ++ docs/src/links.yaml | 5 ++- yarn.lock | 34 +++++++++---------- 6 files changed, 23 insertions(+), 30 deletions(-) rename docs/src/demos/Examples/{FullEditor => VModel}/index.vue (100%) delete mode 100644 docs/src/docPages/examples/full-editor.md create mode 100644 docs/src/docPages/examples/v-model.md diff --git a/docs/src/demos/Examples/Links/index.vue b/docs/src/demos/Examples/Links/index.vue index 0bdfe621..b67aea84 100644 --- a/docs/src/demos/Examples/Links/index.vue +++ b/docs/src/demos/Examples/Links/index.vue @@ -18,12 +18,6 @@ import Paragraph from '@tiptap/extension-paragraph' import Text from '@tiptap/extension-text' import Link from '@tiptap/extension-link' -const CustomLink = Link.extend({ - renderHTML({ attributes }) { - return ['strong', mergeAttributes(attributes, { rel: this.options.rel }), 0] - }, -}) - export default { components: { EditorContent, @@ -41,7 +35,7 @@ export default { Document(), Paragraph(), Text(), - CustomLink(), + Link(), ], content: `

diff --git a/docs/src/demos/Examples/FullEditor/index.vue b/docs/src/demos/Examples/VModel/index.vue similarity index 100% rename from docs/src/demos/Examples/FullEditor/index.vue rename to docs/src/demos/Examples/VModel/index.vue diff --git a/docs/src/docPages/examples/full-editor.md b/docs/src/docPages/examples/full-editor.md deleted file mode 100644 index 1a82b180..00000000 --- a/docs/src/docPages/examples/full-editor.md +++ /dev/null @@ -1,3 +0,0 @@ -# Full Editor - - diff --git a/docs/src/docPages/examples/v-model.md b/docs/src/docPages/examples/v-model.md new file mode 100644 index 00000000..ff827b1a --- /dev/null +++ b/docs/src/docPages/examples/v-model.md @@ -0,0 +1,3 @@ +# Use v-model + + diff --git a/docs/src/links.yaml b/docs/src/links.yaml index 12aacccf..8b8473fb 100644 --- a/docs/src/links.yaml +++ b/docs/src/links.yaml @@ -22,7 +22,6 @@ link: /examples/formatting - title: Links link: /examples/links - draft: true - title: Todo App link: /examples/todo-app - title: Read-only @@ -31,8 +30,8 @@ link: /examples/minimalist - title: Export HTML or JSON link: /examples/export-html-or-json - - title: Full Editor - link: /examples/full-editor + - title: Use v-model + link: /examples/v-model draft: true - title: Share feedback link: /overview/feedback diff --git a/yarn.lock b/yarn.lock index 3050a6b1..2a04be6d 100644 --- a/yarn.lock +++ b/yarn.lock @@ -3428,7 +3428,7 @@ bn.js@^4.0.0, bn.js@^4.1.0, bn.js@^4.4.0: resolved "https://registry.yarnpkg.com/bn.js/-/bn.js-4.11.9.tgz#26d556829458f9d1e81fc48952493d0ba3507828" integrity sha512-E6QoYqCKZfgatHTdHzs1RRKP7ip4vvm+EyRUeE2RF0NblwVvb0p6jSVeNTOFxPn26QXN2o6SMfNxKp6kU8zQaw== -bn.js@^5.1.1: +bn.js@^5.0.0, bn.js@^5.1.1: version "5.1.3" resolved "https://registry.yarnpkg.com/bn.js/-/bn.js-5.1.3.tgz#beca005408f642ebebea80b042b4d18d2ac0ee6b" integrity sha512-GkTiFpjFtUzU9CbMeJ5iazkCzGL3jrhzerzZIuqLABjbwRaFt33I9tUdSNryIptM+RxDet6OKm2WnLXzW51KsQ== @@ -3543,11 +3543,11 @@ browserify-des@^1.0.0: safe-buffer "^5.1.2" browserify-rsa@^4.0.0, browserify-rsa@^4.0.1: - version "4.0.1" - resolved "https://registry.yarnpkg.com/browserify-rsa/-/browserify-rsa-4.0.1.tgz#21e0abfaf6f2029cf2fafb133567a701d4135524" - integrity sha1-IeCr+vbyApzy+vsTNWenAdQTVSQ= + version "4.1.0" + resolved "https://registry.yarnpkg.com/browserify-rsa/-/browserify-rsa-4.1.0.tgz#b2fd06b5b75ae297f7ce2dc651f918f5be158c8d" + integrity sha512-AdEER0Hkspgno2aR97SAf6vi0y0k8NuOpGnVH3O99rcA5Q6sh8QxcngtHuJ6uXwnfAXNM4Gn1Gb7/MV1+Ymbog== dependencies: - bn.js "^4.1.0" + bn.js "^5.0.0" randombytes "^2.0.1" browserify-sign@^4.0.0: @@ -4741,9 +4741,9 @@ css-tree@1.0.0-alpha.37: source-map "^0.6.1" css-tree@^1.0.0: - version "1.0.0" - resolved "https://registry.yarnpkg.com/css-tree/-/css-tree-1.0.0.tgz#21993fa270d742642a90409a2c0cb3ac0298adf6" - integrity sha512-CdVYz/Yuqw0VdKhXPBIgi8DO3NicJVYZNWeX9XcIuSp9ZoFT5IcleVRW07O5rMjdcx1mb+MEJPknTTEW7DdsYw== + version "1.0.1" + resolved "https://registry.yarnpkg.com/css-tree/-/css-tree-1.0.1.tgz#7726678dfe2a57993a018d9dce519bf1760e3b6d" + integrity sha512-WroX+2MvsYcRGP8QA0p+rxzOniT/zpAoQ/DTKDSJzh5T3IQKUkFHeIIfgIapm2uaP178GWY3Mime1qbk8GO/tA== dependencies: mdn-data "2.0.12" source-map "^0.6.1" @@ -4859,9 +4859,9 @@ csso@^4.0.2: css-tree "^1.0.0" csstype@^3.0.2: - version "3.0.4" - resolved "https://registry.yarnpkg.com/csstype/-/csstype-3.0.4.tgz#b156d7be03b84ff425c9a0a4b1e5f4da9c5ca888" - integrity sha512-xc8DUsCLmjvCfoD7LTGE0ou2MIWLx0K9RCZwSHMOdynqRsP4MtUcLeqh1HcQ2dInwDTqn+3CE0/FZh1et+p4jA== + version "3.0.5" + resolved "https://registry.yarnpkg.com/csstype/-/csstype-3.0.5.tgz#7fdec6a28a67ae18647c51668a9ff95bb2fa7bb8" + integrity sha512-uVDi8LpBUKQj6sdxNaTetL6FpeCqTjOvAQuQUa/qAqq8oOd4ivkbhgnqayl0dnPal8Tb/yB1tF+gOvCBiicaiQ== currently-unhandled@^0.4.1: version "0.4.1" @@ -5461,9 +5461,9 @@ ee-first@1.1.1: integrity sha1-WQxhFWsK4vTwJVcyoViyZrxWsh0= electron-to-chromium@^1.3.591: - version "1.3.593" - resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.3.593.tgz#947ccf6dc8e013e2b053d2463ecd1043c164fcef" - integrity sha512-GvO7G1ZxvffnMvPCr4A7+iQPVuvpyqMrx2VWSERAjG+pHK6tmO9XqYdBfMIq9corRyi4bNImSDEiDvIoDb8HrA== + version "1.3.595" + resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.3.595.tgz#e8a9e7c6919963419f892ea981d7b3438ccb834d" + integrity sha512-JpaBIhdBkF9FLG7x06ONfe0f5bxPrxRcq0X+Sc8vsCt+OPWIzxOD+qM71NEHLGbDfN9Q6hbtHRv4/dnvcOxo6g== elegant-spinner@^1.0.1: version "1.0.1" @@ -13717,9 +13717,9 @@ type-check@^0.4.0, type-check@~0.4.0: prelude-ls "^1.2.1" type-fest@^0.18.0: - version "0.18.0" - resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-0.18.0.tgz#2edfa6382d48653707344f7fccdb0443d460e8d6" - integrity sha512-fbDukFPnJBdn2eZ3RR+5mK2slHLFd6gYHY7jna1KWWy4Yr4XysHuCdXRzy+RiG/HwG4WJat00vdC2UHky5eKiQ== + version "0.18.1" + resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-0.18.1.tgz#db4bc151a4a2cf4eebf9add5db75508db6cc841f" + integrity sha512-OIAYXk8+ISY+qTOwkHtKqzAuxchoMiD9Udx+FSGQDuiRR+PJKJHc2NJAXlbhkGwTt/4/nKZxELY1w3ReWOL8mw== type-fest@^0.3.0: version "0.3.1" From bb9e159642a31fd229118db1ec33bb2b4f4e0387 Mon Sep 17 00:00:00 2001 From: Hans Pagel Date: Fri, 13 Nov 2020 11:04:31 +0100 Subject: [PATCH 2/2] replace renderless with headless --- README.md | 6 +++--- docs/src/demos/Guide/BuildYourEditor/index.vue | 2 +- docs/src/docPages/api/extensions/dropcursor.md | 2 +- docs/src/docPages/api/extensions/gapcursor.md | 2 +- docs/src/docPages/api/marks/link.md | 2 +- docs/src/docPages/examples/links.md | 2 +- docs/src/docPages/guide/custom-styling.md | 2 +- docs/src/docPages/introduction.md | 6 +++--- 8 files changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 079dff9d..6d323721 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ # tiptap 2 (Preview!) -A renderless and extendable rich-text editor, based on [ProseMirror](https://github.com/ProseMirror/prosemirror), which is already in use at many well-known companies such as *New York Times*, *The Guardian* or *Atlassian*. +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*. [![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis) -tiptap is a renderless 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*. +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*. 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. You’ll have a better understanding of how everything works under the hood and get more familiar with many terms and jargon used by tiptap. ## Features -**Renderless.** 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 renderless and comes without any CSS. You are in full control over markup and styling. +**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 and styling. **Framework-agnostic.** We don’t care what framework you use. tiptap is ready to be used with plain JavaScript or Vue.js. That makes it even possible to write a renderer for React, Svelte and others.