Merge branch 'feature/landingpage' of https://github.com/ueberdosis/tiptap-next into feature/landingpage

This commit is contained in:
Philipp Kühn
2021-02-04 09:42:31 +01:00
2 changed files with 76 additions and 22 deletions

View File

@@ -104,6 +104,8 @@
<a :href="editLink" target="_blank">Edit this page on GitHub</a> <a :href="editLink" target="_blank">Edit this page on GitHub</a>
&middot; &middot;
Made with 🖤 by <a href="https://twitter.com/_ueberdosis">überdosis</a> Made with 🖤 by <a href="https://twitter.com/_ueberdosis">überdosis</a>
&middot;
Based on <a href="https://prosemirror.net/">ProseMirror by Marijn Haverbeke</a>
</footer> </footer>
</div> </div>
</template> </template>
@@ -165,13 +167,20 @@ export default {
editLink() { editLink() {
const { currentPath } = this const { currentPath } = this
const filePath = currentPath === '' ? '/introduction' : currentPath
if (process.env.NODE_ENV === 'development') { 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`
}, },
}, },

View File

@@ -3,13 +3,10 @@
<app-section> <app-section>
<div class="text"> <div class="text">
<h1 class="is-large"> <h1 class="is-large">
A framework to build the editor you want The headless editor framework for web artisans.
</h1> </h1>
<p class="is-large"> <p class="is-large">
tiptap is a headless wrapper around <a href="https://ProseMirror.net">ProseMirror</a> a toolkit for building rich text WYSIWYG editors, which is already in use at many well-known companies such as <em>New York Times</em>, <em>The Guardian</em> or <em>Atlassian</em>. tiptap gives you full control about every single aspect of your text editor experience. Its 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! Its free.
</p>
<p class="is-large">
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. Its backed by a welcoming community, open source, and free.
</p> </p>
</div> </div>
</app-section> </app-section>
@@ -97,21 +94,33 @@
Quickstart Quickstart
</h2> </h2>
<p> <p>
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:
</p> </p>
<!-- eslint-disable --> <!-- eslint-disable -->
<prism>import { Editor } from '@tiptap/core' <prism language="html">&lt;!DOCTYPE html&gt;
import { defaultExtensions } from '@tiptap/starter-kit' &lt;html lang="en"&gt;
&lt;head&gt;
&lt;meta charset="UTF-8"&gt;
&lt;/head&gt;
&lt;body&gt;
&lt;div class="element"&gt;&lt;/div&gt;
new Editor({ &lt;script type="module"&gt;
element: document.querySelector('.element'), import { Editor } from 'https://cdn.skypack.dev/@tiptap/core?min'
extensions: defaultExtensions(), import { defaultExtensions } from 'https://cdn.skypack.dev/@tiptap/starter-kit?min'
content: '&lt;p&gt;Your content.&lt;/p&gt;',
})</prism> const editor = new Editor({
element: document.querySelector('.element'),
extensions: defaultExtensions(),
content: '&lt;p&gt;Hello World :-)&lt;/p&gt;',
})
&lt;/script&gt;
&lt;/body&gt;
&lt;/html&gt;</prism>
<!-- eslint-enable --> <!-- eslint-enable -->
<p> <p>
<g-link to="/overview/installation"> <g-link to="/overview/installation">
Learn more Learn More
</g-link> </g-link>
</p> </p>
</div> </div>
@@ -183,11 +192,11 @@ new Editor({
License License
</h2> </h2>
<p> <p>
tiptap is licensed under <g-link to="https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md"> tiptap is licensed under <a href="https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md">MIT</a>, so you are free to do whatever you want. If you are using it commercially, do the right thing and <g-link to="/sponsor">
MIT become one of our wonderful sponsors<!--
</g-link>, so youre free to do whatever you want. If youre using it in production, do the right thing and <g-link to="/sponsor"> -->
become one of our wonderful sponsors </g-link> to fund the maintenance, support and development of tiptap now and in the future. Thats all we ask for.
</g-link>(/sponsor) to fund the development, maintenance and support of tiptap and the whole ecosystem. </a>
</p> </p>
</div> </div>
</app-section> </app-section>
@@ -211,5 +220,41 @@ export default {
LogoItem, LogoItem,
Prism, 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',
},
],
}
},
} }
</script> </script>