From 1cf60b290ca43784d3bed3be5a880d69b68fbc03 Mon Sep 17 00:00:00 2001 From: Hans Pagel Date: Mon, 16 Nov 2020 15:23:08 +0100 Subject: [PATCH] add READMEs to all packages --- packages/core/README.md | 14 ++++++++++++++ packages/extension-blockquote/README.md | 14 ++++++++++++++ packages/extension-bold/README.md | 14 ++++++++++++++ packages/extension-bullet-list/README.md | 14 ++++++++++++++ packages/extension-code-block/README.md | 14 ++++++++++++++ packages/extension-code/README.md | 14 ++++++++++++++ packages/extension-collaboration-cursor/README.md | 14 ++++++++++++++ packages/extension-collaboration/README.md | 14 ++++++++++++++ packages/extension-document/README.md | 14 ++++++++++++++ packages/extension-dropcursor/README.md | 14 ++++++++++++++ packages/extension-focus/README.md | 14 ++++++++++++++ packages/extension-font-family/README.md | 14 ++++++++++++++ packages/extension-gapcursor/README.md | 14 ++++++++++++++ packages/extension-hard-break/README.md | 14 ++++++++++++++ packages/extension-heading/README.md | 14 ++++++++++++++ packages/extension-highlight/README.md | 14 ++++++++++++++ packages/extension-history/README.md | 14 ++++++++++++++ packages/extension-horizontal-rule/README.md | 14 ++++++++++++++ packages/extension-image/README.md | 14 ++++++++++++++ packages/extension-italic/README.md | 14 ++++++++++++++ packages/extension-link/README.md | 14 ++++++++++++++ packages/extension-list-item/README.md | 14 ++++++++++++++ packages/extension-ordered-list/README.md | 14 ++++++++++++++ packages/extension-paragraph/README.md | 14 ++++++++++++++ packages/extension-strike/README.md | 14 ++++++++++++++ packages/extension-task-item/README.md | 14 ++++++++++++++ packages/extension-task-list/README.md | 14 ++++++++++++++ packages/extension-text-align/README.md | 14 ++++++++++++++ packages/extension-text-style/README.md | 14 ++++++++++++++ packages/extension-text/README.md | 14 ++++++++++++++ packages/extension-typography/README.md | 14 ++++++++++++++ packages/extension-underline/README.md | 14 ++++++++++++++ packages/html/README.md | 14 ++++++++++++++ packages/starter-kit/README.md | 14 ++++++++++++++ packages/vue-starter-kit/README.md | 14 ++++++++++++++ packages/vue/README.md | 14 ++++++++++++++ 36 files changed, 504 insertions(+) create mode 100644 packages/core/README.md create mode 100644 packages/extension-blockquote/README.md create mode 100644 packages/extension-bold/README.md create mode 100644 packages/extension-bullet-list/README.md create mode 100644 packages/extension-code-block/README.md create mode 100644 packages/extension-code/README.md create mode 100644 packages/extension-collaboration-cursor/README.md create mode 100644 packages/extension-collaboration/README.md create mode 100644 packages/extension-document/README.md create mode 100644 packages/extension-dropcursor/README.md create mode 100644 packages/extension-focus/README.md create mode 100644 packages/extension-font-family/README.md create mode 100644 packages/extension-gapcursor/README.md create mode 100644 packages/extension-hard-break/README.md create mode 100644 packages/extension-heading/README.md create mode 100644 packages/extension-highlight/README.md create mode 100644 packages/extension-history/README.md create mode 100644 packages/extension-horizontal-rule/README.md create mode 100644 packages/extension-image/README.md create mode 100644 packages/extension-italic/README.md create mode 100644 packages/extension-link/README.md create mode 100644 packages/extension-list-item/README.md create mode 100644 packages/extension-ordered-list/README.md create mode 100644 packages/extension-paragraph/README.md create mode 100644 packages/extension-strike/README.md create mode 100644 packages/extension-task-item/README.md create mode 100644 packages/extension-task-list/README.md create mode 100644 packages/extension-text-align/README.md create mode 100644 packages/extension-text-style/README.md create mode 100644 packages/extension-text/README.md create mode 100644 packages/extension-typography/README.md create mode 100644 packages/extension-underline/README.md create mode 100644 packages/html/README.md create mode 100644 packages/starter-kit/README.md create mode 100644 packages/vue-starter-kit/README.md create mode 100644 packages/vue/README.md diff --git a/packages/core/README.md b/packages/core/README.md new file mode 100644 index 00000000..fa37a49d --- /dev/null +++ b/packages/core/README.md @@ -0,0 +1,14 @@ +# @tiptap/core +[![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?minimal=true) +[![License](https://img.shields.io/npm/l/@tiptap/core.svg)](https://www.npmjs.com/package/@tiptap/core) +[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis) + +## Introduction +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*. + +## Offical Documentation +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). diff --git a/packages/extension-blockquote/README.md b/packages/extension-blockquote/README.md new file mode 100644 index 00000000..4a606ea7 --- /dev/null +++ b/packages/extension-blockquote/README.md @@ -0,0 +1,14 @@ +# @tiptap/extension-blockquote +[![Version](https://img.shields.io/npm/v/@tiptap/extension-blockquote.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-blockquote) +[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-blockquote.svg)](https://npmcharts.com/compare/tiptap?minimal=true) +[![License](https://img.shields.io/npm/l/@tiptap/extension-blockquote.svg)](https://www.npmjs.com/package/@tiptap/extension-blockquote) +[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis) + +## Introduction +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*. + +## Offical Documentation +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). diff --git a/packages/extension-bold/README.md b/packages/extension-bold/README.md new file mode 100644 index 00000000..9394b11d --- /dev/null +++ b/packages/extension-bold/README.md @@ -0,0 +1,14 @@ +# @tiptap/extension-bold +[![Version](https://img.shields.io/npm/v/@tiptap/extension-bold.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-bold) +[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-bold.svg)](https://npmcharts.com/compare/tiptap?minimal=true) +[![License](https://img.shields.io/npm/l/@tiptap/extension-bold.svg)](https://www.npmjs.com/package/@tiptap/extension-bold) +[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis) + +## Introduction +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*. + +## Offical Documentation +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). diff --git a/packages/extension-bullet-list/README.md b/packages/extension-bullet-list/README.md new file mode 100644 index 00000000..bb4ca64b --- /dev/null +++ b/packages/extension-bullet-list/README.md @@ -0,0 +1,14 @@ +# @tiptap/extension-bullet-list +[![Version](https://img.shields.io/npm/v/@tiptap/extension-bullet-list.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-bullet-list) +[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-bullet-list.svg)](https://npmcharts.com/compare/tiptap?minimal=true) +[![License](https://img.shields.io/npm/l/@tiptap/extension-bullet-list.svg)](https://www.npmjs.com/package/@tiptap/extension-bullet-list) +[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis) + +## Introduction +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*. + +## Offical Documentation +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). diff --git a/packages/extension-code-block/README.md b/packages/extension-code-block/README.md new file mode 100644 index 00000000..2e31f092 --- /dev/null +++ b/packages/extension-code-block/README.md @@ -0,0 +1,14 @@ +# @tiptap/extension-bode-block +[![Version](https://img.shields.io/npm/v/@tiptap/extension-bode-block.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-bode-block) +[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-bode-block.svg)](https://npmcharts.com/compare/tiptap?minimal=true) +[![License](https://img.shields.io/npm/l/@tiptap/extension-bode-block.svg)](https://www.npmjs.com/package/@tiptap/extension-bode-block) +[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis) + +## Introduction +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*. + +## Offical Documentation +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). diff --git a/packages/extension-code/README.md b/packages/extension-code/README.md new file mode 100644 index 00000000..b41b85f0 --- /dev/null +++ b/packages/extension-code/README.md @@ -0,0 +1,14 @@ +# @tiptap/extension-code +[![Version](https://img.shields.io/npm/v/@tiptap/extension-code.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-code) +[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-code.svg)](https://npmcharts.com/compare/tiptap?minimal=true) +[![License](https://img.shields.io/npm/l/@tiptap/extension-code.svg)](https://www.npmjs.com/package/@tiptap/extension-code) +[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis) + +## Introduction +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*. + +## Offical Documentation +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). diff --git a/packages/extension-collaboration-cursor/README.md b/packages/extension-collaboration-cursor/README.md new file mode 100644 index 00000000..e4b74325 --- /dev/null +++ b/packages/extension-collaboration-cursor/README.md @@ -0,0 +1,14 @@ +# @tiptap/extension-collaboration-cursor +[![Version](https://img.shields.io/npm/v/@tiptap/extension-collaboration-cursor.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-collaboration-cursor) +[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-collaboration-cursor.svg)](https://npmcharts.com/compare/tiptap?minimal=true) +[![License](https://img.shields.io/npm/l/@tiptap/extension-collaboration-cursor.svg)](https://www.npmjs.com/package/@tiptap/extension-collaboration-cursor) +[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis) + +## Introduction +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*. + +## Offical Documentation +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). diff --git a/packages/extension-collaboration/README.md b/packages/extension-collaboration/README.md new file mode 100644 index 00000000..700ed277 --- /dev/null +++ b/packages/extension-collaboration/README.md @@ -0,0 +1,14 @@ +# @tiptap/extension-collaboration +[![Version](https://img.shields.io/npm/v/@tiptap/extension-collaboration.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-collaboration) +[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-collaboration.svg)](https://npmcharts.com/compare/tiptap?minimal=true) +[![License](https://img.shields.io/npm/l/@tiptap/extension-collaboration.svg)](https://www.npmjs.com/package/@tiptap/extension-collaboration) +[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis) + +## Introduction +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*. + +## Offical Documentation +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). diff --git a/packages/extension-document/README.md b/packages/extension-document/README.md new file mode 100644 index 00000000..45d5b93d --- /dev/null +++ b/packages/extension-document/README.md @@ -0,0 +1,14 @@ +# @tiptap/extension-document +[![Version](https://img.shields.io/npm/v/@tiptap/extension-document.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-document) +[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-document.svg)](https://npmcharts.com/compare/tiptap?minimal=true) +[![License](https://img.shields.io/npm/l/@tiptap/extension-document.svg)](https://www.npmjs.com/package/@tiptap/extension-document) +[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis) + +## Introduction +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*. + +## Offical Documentation +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). diff --git a/packages/extension-dropcursor/README.md b/packages/extension-dropcursor/README.md new file mode 100644 index 00000000..c73ea740 --- /dev/null +++ b/packages/extension-dropcursor/README.md @@ -0,0 +1,14 @@ +# @tiptap/extension-dropcursor +[![Version](https://img.shields.io/npm/v/@tiptap/extension-dropcursor.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-dropcursor) +[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-dropcursor.svg)](https://npmcharts.com/compare/tiptap?minimal=true) +[![License](https://img.shields.io/npm/l/@tiptap/extension-dropcursor.svg)](https://www.npmjs.com/package/@tiptap/extension-dropcursor) +[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis) + +## Introduction +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*. + +## Offical Documentation +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). diff --git a/packages/extension-focus/README.md b/packages/extension-focus/README.md new file mode 100644 index 00000000..2d22a2f7 --- /dev/null +++ b/packages/extension-focus/README.md @@ -0,0 +1,14 @@ +# @tiptap/extension-focus +[![Version](https://img.shields.io/npm/v/@tiptap/extension-focus.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-focus) +[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-focus.svg)](https://npmcharts.com/compare/tiptap?minimal=true) +[![License](https://img.shields.io/npm/l/@tiptap/extension-focus.svg)](https://www.npmjs.com/package/@tiptap/extension-focus) +[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis) + +## Introduction +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*. + +## Offical Documentation +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). diff --git a/packages/extension-font-family/README.md b/packages/extension-font-family/README.md new file mode 100644 index 00000000..e1581b7d --- /dev/null +++ b/packages/extension-font-family/README.md @@ -0,0 +1,14 @@ +# @tiptap/extension-font-family +[![Version](https://img.shields.io/npm/v/@tiptap/extension-font-family.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-font-family) +[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-font-family.svg)](https://npmcharts.com/compare/tiptap?minimal=true) +[![License](https://img.shields.io/npm/l/@tiptap/extension-font-family.svg)](https://www.npmjs.com/package/@tiptap/extension-font-family) +[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis) + +## Introduction +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*. + +## Offical Documentation +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). diff --git a/packages/extension-gapcursor/README.md b/packages/extension-gapcursor/README.md new file mode 100644 index 00000000..bfcbe8bf --- /dev/null +++ b/packages/extension-gapcursor/README.md @@ -0,0 +1,14 @@ +# @tiptap/extension-gapcursor +[![Version](https://img.shields.io/npm/v/@tiptap/extension-gapcursor.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-gapcursor) +[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-gapcursor.svg)](https://npmcharts.com/compare/tiptap?minimal=true) +[![License](https://img.shields.io/npm/l/@tiptap/extension-gapcursor.svg)](https://www.npmjs.com/package/@tiptap/extension-gapcursor) +[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis) + +## Introduction +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*. + +## Offical Documentation +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). diff --git a/packages/extension-hard-break/README.md b/packages/extension-hard-break/README.md new file mode 100644 index 00000000..5399f588 --- /dev/null +++ b/packages/extension-hard-break/README.md @@ -0,0 +1,14 @@ +# @tiptap/extension-hard-break +[![Version](https://img.shields.io/npm/v/@tiptap/extension-hard-break.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-hard-break) +[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-hard-break.svg)](https://npmcharts.com/compare/tiptap?minimal=true) +[![License](https://img.shields.io/npm/l/@tiptap/extension-hard-break.svg)](https://www.npmjs.com/package/@tiptap/extension-hard-break) +[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis) + +## Introduction +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*. + +## Offical Documentation +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). diff --git a/packages/extension-heading/README.md b/packages/extension-heading/README.md new file mode 100644 index 00000000..28b84472 --- /dev/null +++ b/packages/extension-heading/README.md @@ -0,0 +1,14 @@ +# @tiptap/extension-heading +[![Version](https://img.shields.io/npm/v/@tiptap/extension-heading.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-heading) +[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-heading.svg)](https://npmcharts.com/compare/tiptap?minimal=true) +[![License](https://img.shields.io/npm/l/@tiptap/extension-heading.svg)](https://www.npmjs.com/package/@tiptap/extension-heading) +[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis) + +## Introduction +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*. + +## Offical Documentation +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). diff --git a/packages/extension-highlight/README.md b/packages/extension-highlight/README.md new file mode 100644 index 00000000..c77f62db --- /dev/null +++ b/packages/extension-highlight/README.md @@ -0,0 +1,14 @@ +# @tiptap/extension-highlight +[![Version](https://img.shields.io/npm/v/@tiptap/extension-highlight.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-highlight) +[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-highlight.svg)](https://npmcharts.com/compare/tiptap?minimal=true) +[![License](https://img.shields.io/npm/l/@tiptap/extension-highlight.svg)](https://www.npmjs.com/package/@tiptap/extension-highlight) +[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis) + +## Introduction +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*. + +## Offical Documentation +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). diff --git a/packages/extension-history/README.md b/packages/extension-history/README.md new file mode 100644 index 00000000..beabb686 --- /dev/null +++ b/packages/extension-history/README.md @@ -0,0 +1,14 @@ +# @tiptap/extension-history +[![Version](https://img.shields.io/npm/v/@tiptap/extension-history.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-history) +[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-history.svg)](https://npmcharts.com/compare/tiptap?minimal=true) +[![License](https://img.shields.io/npm/l/@tiptap/extension-history.svg)](https://www.npmjs.com/package/@tiptap/extension-history) +[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis) + +## Introduction +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*. + +## Offical Documentation +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). diff --git a/packages/extension-horizontal-rule/README.md b/packages/extension-horizontal-rule/README.md new file mode 100644 index 00000000..70897d39 --- /dev/null +++ b/packages/extension-horizontal-rule/README.md @@ -0,0 +1,14 @@ +# @tiptap/extension-horizontal-rule +[![Version](https://img.shields.io/npm/v/@tiptap/extension-horizontal-rule.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-horizontal-rule) +[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-horizontal-rule.svg)](https://npmcharts.com/compare/tiptap?minimal=true) +[![License](https://img.shields.io/npm/l/@tiptap/extension-horizontal-rule.svg)](https://www.npmjs.com/package/@tiptap/extension-horizontal-rule) +[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis) + +## Introduction +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*. + +## Offical Documentation +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). diff --git a/packages/extension-image/README.md b/packages/extension-image/README.md new file mode 100644 index 00000000..03351fcd --- /dev/null +++ b/packages/extension-image/README.md @@ -0,0 +1,14 @@ +# @tiptap/extension-image +[![Version](https://img.shields.io/npm/v/@tiptap/extension-image.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-image) +[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-image.svg)](https://npmcharts.com/compare/tiptap?minimal=true) +[![License](https://img.shields.io/npm/l/@tiptap/extension-image.svg)](https://www.npmjs.com/package/@tiptap/extension-image) +[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis) + +## Introduction +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*. + +## Offical Documentation +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). diff --git a/packages/extension-italic/README.md b/packages/extension-italic/README.md new file mode 100644 index 00000000..f153737a --- /dev/null +++ b/packages/extension-italic/README.md @@ -0,0 +1,14 @@ +# @tiptap/extension-italic +[![Version](https://img.shields.io/npm/v/@tiptap/extension-italic.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-italic) +[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-italic.svg)](https://npmcharts.com/compare/tiptap?minimal=true) +[![License](https://img.shields.io/npm/l/@tiptap/extension-italic.svg)](https://www.npmjs.com/package/@tiptap/extension-italic) +[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis) + +## Introduction +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*. + +## Offical Documentation +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). diff --git a/packages/extension-link/README.md b/packages/extension-link/README.md new file mode 100644 index 00000000..012261b3 --- /dev/null +++ b/packages/extension-link/README.md @@ -0,0 +1,14 @@ +# @tiptap/extension-link +[![Version](https://img.shields.io/npm/v/@tiptap/extension-link.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-link) +[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-link.svg)](https://npmcharts.com/compare/tiptap?minimal=true) +[![License](https://img.shields.io/npm/l/@tiptap/extension-link.svg)](https://www.npmjs.com/package/@tiptap/extension-link) +[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis) + +## Introduction +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*. + +## Offical Documentation +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). diff --git a/packages/extension-list-item/README.md b/packages/extension-list-item/README.md new file mode 100644 index 00000000..42c60c51 --- /dev/null +++ b/packages/extension-list-item/README.md @@ -0,0 +1,14 @@ +# @tiptap/extension-list-item +[![Version](https://img.shields.io/npm/v/@tiptap/extension-list-item.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-list-item) +[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-list-item.svg)](https://npmcharts.com/compare/tiptap?minimal=true) +[![License](https://img.shields.io/npm/l/@tiptap/extension-list-item.svg)](https://www.npmjs.com/package/@tiptap/extension-list-item) +[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis) + +## Introduction +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*. + +## Offical Documentation +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). diff --git a/packages/extension-ordered-list/README.md b/packages/extension-ordered-list/README.md new file mode 100644 index 00000000..bfea99cd --- /dev/null +++ b/packages/extension-ordered-list/README.md @@ -0,0 +1,14 @@ +# @tiptap/extension-ordered-list +[![Version](https://img.shields.io/npm/v/@tiptap/extension-ordered-list.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-ordered-list) +[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-ordered-list.svg)](https://npmcharts.com/compare/tiptap?minimal=true) +[![License](https://img.shields.io/npm/l/@tiptap/extension-ordered-list.svg)](https://www.npmjs.com/package/@tiptap/extension-ordered-list) +[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis) + +## Introduction +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*. + +## Offical Documentation +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). diff --git a/packages/extension-paragraph/README.md b/packages/extension-paragraph/README.md new file mode 100644 index 00000000..13d6af50 --- /dev/null +++ b/packages/extension-paragraph/README.md @@ -0,0 +1,14 @@ +# @tiptap/extension-paragraph +[![Version](https://img.shields.io/npm/v/@tiptap/extension-paragraph.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-paragraph) +[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-paragraph.svg)](https://npmcharts.com/compare/tiptap?minimal=true) +[![License](https://img.shields.io/npm/l/@tiptap/extension-paragraph.svg)](https://www.npmjs.com/package/@tiptap/extension-paragraph) +[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis) + +## Introduction +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*. + +## Offical Documentation +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). diff --git a/packages/extension-strike/README.md b/packages/extension-strike/README.md new file mode 100644 index 00000000..2984666f --- /dev/null +++ b/packages/extension-strike/README.md @@ -0,0 +1,14 @@ +# @tiptap/extension-strike +[![Version](https://img.shields.io/npm/v/@tiptap/extension-strike.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-strike) +[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-strike.svg)](https://npmcharts.com/compare/tiptap?minimal=true) +[![License](https://img.shields.io/npm/l/@tiptap/extension-strike.svg)](https://www.npmjs.com/package/@tiptap/extension-strike) +[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis) + +## Introduction +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*. + +## Offical Documentation +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). diff --git a/packages/extension-task-item/README.md b/packages/extension-task-item/README.md new file mode 100644 index 00000000..2bf09e32 --- /dev/null +++ b/packages/extension-task-item/README.md @@ -0,0 +1,14 @@ +# @tiptap/extension-task-item +[![Version](https://img.shields.io/npm/v/@tiptap/extension-task-item.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-task-item) +[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-task-item.svg)](https://npmcharts.com/compare/tiptap?minimal=true) +[![License](https://img.shields.io/npm/l/@tiptap/extension-task-item.svg)](https://www.npmjs.com/package/@tiptap/extension-task-item) +[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis) + +## Introduction +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*. + +## Offical Documentation +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). diff --git a/packages/extension-task-list/README.md b/packages/extension-task-list/README.md new file mode 100644 index 00000000..d7e4d8c6 --- /dev/null +++ b/packages/extension-task-list/README.md @@ -0,0 +1,14 @@ +# @tiptap/extension-task-list +[![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?minimal=true) +[![License](https://img.shields.io/npm/l/@tiptap/extension-task-list.svg)](https://www.npmjs.com/package/@tiptap/extension-task-list) +[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis) + +## Introduction +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*. + +## Offical Documentation +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). diff --git a/packages/extension-text-align/README.md b/packages/extension-text-align/README.md new file mode 100644 index 00000000..fc856a48 --- /dev/null +++ b/packages/extension-text-align/README.md @@ -0,0 +1,14 @@ +# @tiptap/extension-text-align +[![Version](https://img.shields.io/npm/v/@tiptap/extension-text-align.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-text-align) +[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-text-align.svg)](https://npmcharts.com/compare/tiptap?minimal=true) +[![License](https://img.shields.io/npm/l/@tiptap/extension-text-align.svg)](https://www.npmjs.com/package/@tiptap/extension-text-align) +[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis) + +## Introduction +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*. + +## Offical Documentation +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). diff --git a/packages/extension-text-style/README.md b/packages/extension-text-style/README.md new file mode 100644 index 00000000..d91d7aa8 --- /dev/null +++ b/packages/extension-text-style/README.md @@ -0,0 +1,14 @@ +# @tiptap/extension-text-style +[![Version](https://img.shields.io/npm/v/@tiptap/extension-text-style.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-text-style) +[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-text-style.svg)](https://npmcharts.com/compare/tiptap?minimal=true) +[![License](https://img.shields.io/npm/l/@tiptap/extension-text-style.svg)](https://www.npmjs.com/package/@tiptap/extension-text-style) +[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis) + +## Introduction +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*. + +## Offical Documentation +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). diff --git a/packages/extension-text/README.md b/packages/extension-text/README.md new file mode 100644 index 00000000..87aa3fca --- /dev/null +++ b/packages/extension-text/README.md @@ -0,0 +1,14 @@ +# @tiptap/extension-text +[![Version](https://img.shields.io/npm/v/@tiptap/extension-text.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-text) +[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-text.svg)](https://npmcharts.com/compare/tiptap?minimal=true) +[![License](https://img.shields.io/npm/l/@tiptap/extension-text.svg)](https://www.npmjs.com/package/@tiptap/extension-text) +[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis) + +## Introduction +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*. + +## Offical Documentation +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). diff --git a/packages/extension-typography/README.md b/packages/extension-typography/README.md new file mode 100644 index 00000000..ac274a62 --- /dev/null +++ b/packages/extension-typography/README.md @@ -0,0 +1,14 @@ +# @tiptap/extension-typography +[![Version](https://img.shields.io/npm/v/@tiptap/extension-typography.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-typography) +[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-typography.svg)](https://npmcharts.com/compare/tiptap?minimal=true) +[![License](https://img.shields.io/npm/l/@tiptap/extension-typography.svg)](https://www.npmjs.com/package/@tiptap/extension-typography) +[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis) + +## Introduction +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*. + +## Offical Documentation +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). diff --git a/packages/extension-underline/README.md b/packages/extension-underline/README.md new file mode 100644 index 00000000..9953862e --- /dev/null +++ b/packages/extension-underline/README.md @@ -0,0 +1,14 @@ +# @tiptap/extension-underline +[![Version](https://img.shields.io/npm/v/@tiptap/extension-underline.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-underline) +[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-underline.svg)](https://npmcharts.com/compare/tiptap?minimal=true) +[![License](https://img.shields.io/npm/l/@tiptap/extension-underline.svg)](https://www.npmjs.com/package/@tiptap/extension-underline) +[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis) + +## Introduction +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*. + +## Offical Documentation +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). diff --git a/packages/html/README.md b/packages/html/README.md new file mode 100644 index 00000000..8d4b1063 --- /dev/null +++ b/packages/html/README.md @@ -0,0 +1,14 @@ +# @tiptap/html +[![Version](https://img.shields.io/npm/v/@tiptap/html.svg?label=version)](https://www.npmjs.com/package/@tiptap/html) +[![Downloads](https://img.shields.io/npm/dm/@tiptap/html.svg)](https://npmcharts.com/compare/tiptap?minimal=true) +[![License](https://img.shields.io/npm/l/@tiptap/html.svg)](https://www.npmjs.com/package/@tiptap/html) +[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis) + +## Introduction +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*. + +## Offical Documentation +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). diff --git a/packages/starter-kit/README.md b/packages/starter-kit/README.md new file mode 100644 index 00000000..7c732735 --- /dev/null +++ b/packages/starter-kit/README.md @@ -0,0 +1,14 @@ +# @tiptap/starter-kit +[![Version](https://img.shields.io/npm/v/@tiptap/starter-kit.svg?label=version)](https://www.npmjs.com/package/@tiptap/starter-kit) +[![Downloads](https://img.shields.io/npm/dm/@tiptap/starter-kit.svg)](https://npmcharts.com/compare/tiptap?minimal=true) +[![License](https://img.shields.io/npm/l/@tiptap/starter-kit.svg)](https://www.npmjs.com/package/@tiptap/starter-kit) +[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis) + +## Introduction +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*. + +## Offical Documentation +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). diff --git a/packages/vue-starter-kit/README.md b/packages/vue-starter-kit/README.md new file mode 100644 index 00000000..0ced0098 --- /dev/null +++ b/packages/vue-starter-kit/README.md @@ -0,0 +1,14 @@ +# @tiptap/vue-starter-kit +[![Version](https://img.shields.io/npm/v/@tiptap/vue-starter-kit.svg?label=version)](https://www.npmjs.com/package/@tiptap/vue-starter-kit) +[![Downloads](https://img.shields.io/npm/dm/@tiptap/vue-starter-kit.svg)](https://npmcharts.com/compare/tiptap?minimal=true) +[![License](https://img.shields.io/npm/l/@tiptap/vue-starter-kit.svg)](https://www.npmjs.com/package/@tiptap/vue-starter-kit) +[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis) + +## Introduction +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*. + +## Offical Documentation +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). diff --git a/packages/vue/README.md b/packages/vue/README.md new file mode 100644 index 00000000..33f362c3 --- /dev/null +++ b/packages/vue/README.md @@ -0,0 +1,14 @@ +# @tiptap/vue +[![Version](https://img.shields.io/npm/v/@tiptap/vue.svg?label=version)](https://www.npmjs.com/package/@tiptap/vue) +[![Downloads](https://img.shields.io/npm/dm/@tiptap/vue.svg)](https://npmcharts.com/compare/tiptap?minimal=true) +[![License](https://img.shields.io/npm/l/@tiptap/vue.svg)](https://www.npmjs.com/package/@tiptap/vue) +[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis) + +## Introduction +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*. + +## Offical Documentation +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).