diff --git a/docs/src/layouts/App/index.vue b/docs/src/layouts/App/index.vue
index e2703ecf..156d7cbc 100644
--- a/docs/src/layouts/App/index.vue
+++ b/docs/src/layouts/App/index.vue
@@ -104,6 +104,8 @@
Edit this page on GitHub
·
Made with đź–¤ by ĂĽberdosis
+ ·
+ Based on ProseMirror by Marijn Haverbeke
@@ -165,13 +167,20 @@ export default {
editLink() {
const { currentPath } = this
- const filePath = currentPath === '' ? '/introduction' : currentPath
if (process.env.NODE_ENV === 'development') {
- return `vscode://file${this.cwd}/src/docPages${filePath}.md`
+ if (currentPath === '') {
+ return `vscode://file${this.cwd}/src/pages/index.vue`
+ }
+
+ return `vscode://file${this.cwd}/src/docPages${currentPath}.md`
}
- return `https://github.com/ueberdosis/tiptap-next/blob/main/docs/src/docPages${filePath}.md`
+ if (currentPath === '') {
+ return 'https://github.com/ueberdosis/tiptap-next/blob/main/docs/src/pages/index.vue'
+ }
+
+ return `https://github.com/ueberdosis/tiptap-next/blob/main/docs/src/docPages${currentPath}.md`
},
},
diff --git a/docs/src/pages/index.vue b/docs/src/pages/index.vue
index ec177123..1e0423f1 100644
--- a/docs/src/pages/index.vue
+++ b/docs/src/pages/index.vue
@@ -3,13 +3,10 @@
- A framework to build the editor you want
+ The headless editor framework for web artisans.
- tiptap is a headless wrapper around ProseMirror – 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.
+ 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.
@@ -97,21 +94,33 @@
Quickstart
- To pull in tiptap for quick demos or giving it just a spin, grab the latest build via CDN. We use two different provides:
+ For quick demos or to give it just a spin, grab the latest build from a CDN. Here is a quick example to get you started with tiptap:
-import { Editor } from '@tiptap/core'
-import { defaultExtensions } from '@tiptap/starter-kit'
+<!DOCTYPE html>
+<html lang="en">
+<head>
+ <meta charset="UTF-8">
+</head>
+<body>
+ <div class="element"></div>
-new Editor({
- element: document.querySelector('.element'),
- extensions: defaultExtensions(),
- content: '<p>Your content.</p>',
-})
+ <script type="module">
+ import { Editor } from 'https://cdn.skypack.dev/@tiptap/core?min'
+ import { defaultExtensions } from 'https://cdn.skypack.dev/@tiptap/starter-kit?min'
+
+ const editor = new Editor({
+ element: document.querySelector('.element'),
+ extensions: defaultExtensions(),
+ content: '<p>Hello World :-)</p>',
+ })
+ </script>
+</body>
+</html>
- Learn more
+ Learn More
@@ -183,11 +192,11 @@ new Editor({
License
- tiptap is licensed under
- MIT
- , so you’re free to do whatever you want. If you’re using it in production, do the right thing and
- become one of our wonderful sponsors
- (/sponsor) to fund the development, maintenance and support of tiptap and the whole ecosystem.
+ tiptap is licensed under MIT, so you are free to do whatever you want. If you are using it commercially, do the right thing and
+ become one of our wonderful sponsors
+ to fund the maintenance, support and development of tiptap now and in the future. That’s all we ask for.
+
@@ -211,5 +220,41 @@ export default {
LogoItem,
Prism,
},
+
+ metaInfo() {
+ const title = 'Headless WYSIWYG Text Editor'
+
+ return {
+ title,
+ meta: [
+ /* OpenGraph */
+ {
+ property: 'og:title',
+ content: title,
+ },
+ {
+ property: 'og:image',
+ content: 'https://next.tiptap.dev/og-image.png',
+ },
+ /* Twitter */
+ {
+ name: 'twitter:title',
+ content: title,
+ },
+ {
+ name: 'twitter:card',
+ content: 'summary_large_image',
+ },
+ {
+ name: 'twitter:image',
+ content: 'https://next.tiptap.dev/og-image.png',
+ },
+ {
+ name: 'twitter:site',
+ content: '@_ueberdosis',
+ },
+ ],
+ }
+ },
}