diff --git a/docs/src/data/links.yaml b/docs/src/data/links.yaml index 3809fafa..a803a7e8 100644 --- a/docs/src/data/links.yaml +++ b/docs/src/data/links.yaml @@ -1,5 +1,7 @@ - title: Getting Started items: + - title: Introduction + link: /introduction/ - title: Installation link: /installation/ diff --git a/docs/src/data/posts/editor.md b/docs/src/data/posts/editor.md index 8df1f9f9..0c320aad 100644 --- a/docs/src/data/posts/editor.md +++ b/docs/src/data/posts/editor.md @@ -1,5 +1,3 @@ # Editor -This class is a central building block of tiptap. It does most of the heavy lifting of creating a working [ProseMirror](https://ProseMirror.net/) editor such as creating the [`EditorView`](https://ProseMirror.net/docs/ref/#view.EditorView), setting the initial [`EditorState`](https://ProseMirror.net/docs/ref/#state.Editor_State) and so on. - -Although tiptap tries to hide most of the complexity of [ProseMirror](https://ProseMirror.net/docs/), tiptap is built on top of its APIs and we strongly recommend you to read through the [ProseMirror Guide](https://ProseMirror.net/docs/guide/). You'll have a better understanding of how everything works under the hood and get familiar with many terms and jargon used by tiptap. \ No newline at end of file +This class is a central building block of tiptap. It does most of the heavy lifting of creating a working [ProseMirror](https://ProseMirror.net/) editor such as creating the [`EditorView`](https://ProseMirror.net/docs/ref/#view.EditorView), setting the initial [`EditorState`](https://ProseMirror.net/docs/ref/#state.Editor_State) and so on. \ No newline at end of file diff --git a/docs/src/data/posts/introduction.md b/docs/src/data/posts/introduction.md new file mode 100644 index 00000000..c3110694 --- /dev/null +++ b/docs/src/data/posts/introduction.md @@ -0,0 +1,23 @@ +# Introduction + +tiptap is a renderless wrapper around [ProseMirror](https://ProseMirror.net) – a toolkit for building rich-text editors that are 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 is built on top of its APIs and we strongly recommend you to read through the [ProseMirror Guide](https://ProseMirror.net/docs/guide/). You’ll have a better understanding of how everything works under the hood and get familiar with many terms and jargon used by tiptap. + +## Who is using tiptap already? +- [GitLab](https://gitlab.com) +- [Statamic CMS](https://statamic.com) +- [Twill CMS](https://twill.io) +- [ApostropheCMS](https://apostrophecms.com) +- [Directus CMS](https://directus.io) +- [Nextcloud](https://apps.nextcloud.com/apps/text) +- [and many more →](https://github.com/scrumpy/tiptap/network/dependents?package_id=UGFja2FnZS0xMzE5OTg0ODc%3D) + +## Contributing + +Please see the [`CONTRIBUTING`](https://github.com/scrumpy/tiptap/blob/master/CONTRIBUTING.md) file for details. + +```bash +yarn install +yarn start +``` diff --git a/docs/src/data/posts/renderless.md b/docs/src/data/posts/renderless.md index c3d22836..6dc43113 100644 --- a/docs/src/data/posts/renderless.md +++ b/docs/src/data/posts/renderless.md @@ -1,3 +1,3 @@ # Renderless -tiptap comes without any CSS. \ No newline at end of file +The implementation of a text editor can be very specific for each use case. We don’t want to 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’ll have full control over markup and styling. diff --git a/docs/src/data/posts/schema.md b/docs/src/data/posts/schema.md index 9946ba95..a396cbee 100644 --- a/docs/src/data/posts/schema.md +++ b/docs/src/data/posts/schema.md @@ -1 +1,3 @@ -# Schema \ No newline at end of file +# Schema + +Compared to many other editors, tiptap is based on a [schema](https://prosemirror.net/docs/guide/#schema) that defines how the content is structured. For example this allows you to define the kind of nodes that may occur in the document, and the way they can be nested.