mirror of
https://github.com/ueberdosis/tiptap.git
synced 2024-11-28 07:40:13 +08:00
add some styling
This commit is contained in:
parent
ba49b3b362
commit
7eeb4265fd
@ -44,7 +44,7 @@ module.exports = {
|
||||
typeName: 'DocPage',
|
||||
baseDir: './src/docPages',
|
||||
template: './src/templates/DocPage/index.vue',
|
||||
index: './introduction',
|
||||
// index: './introduction',
|
||||
plugins: [
|
||||
'@gridsome/remark-prismjs',
|
||||
'remark-container',
|
||||
|
9
docs/src/components/AppSection/index.vue
Normal file
9
docs/src/components/AppSection/index.vue
Normal file
@ -0,0 +1,9 @@
|
||||
<template>
|
||||
<section class="app-section">
|
||||
<div class="app-section__inner">
|
||||
<slot />
|
||||
</div>
|
||||
</section>
|
||||
</template>
|
||||
|
||||
<style lang="scss" src="./style.scss"></style>
|
15
docs/src/components/AppSection/style.scss
Normal file
15
docs/src/components/AppSection/style.scss
Normal file
@ -0,0 +1,15 @@
|
||||
.app-section {
|
||||
position: relative;
|
||||
|
||||
&__inner {
|
||||
position: relative;
|
||||
z-index: 2;
|
||||
padding: 4rem 1rem;
|
||||
margin: 0 auto;
|
||||
max-width: 50rem;
|
||||
|
||||
// @media (min-width: $mobileBreakPoint) {
|
||||
// padding: 0 2rem;
|
||||
// }
|
||||
}
|
||||
}
|
@ -63,12 +63,12 @@
|
||||
width: 100%;
|
||||
padding: 0.5rem 1.25rem;
|
||||
font-size: 0.85rem;
|
||||
border: 1px solid rgba($colorWhite, 0.1);
|
||||
border-top: 1px solid rgba($colorWhite, 0.1);
|
||||
border-bottom-left-radius: inherit;
|
||||
border-bottom-right-radius: inherit;
|
||||
border-top-width: 0;
|
||||
background-color: $colorBlack;
|
||||
white-space: nowrap;
|
||||
color: rgba($colorWhite, 0.5);
|
||||
}
|
||||
|
||||
&__name {
|
||||
@ -84,6 +84,10 @@
|
||||
|
||||
&__link {
|
||||
margin-left: auto;
|
||||
|
||||
&:hover {
|
||||
color: $colorWhite;
|
||||
}
|
||||
}
|
||||
|
||||
&__error {
|
||||
|
@ -33,7 +33,7 @@
|
||||
</div>
|
||||
|
||||
<div class="app__content">
|
||||
<div class="app__sidebar">
|
||||
<div class="app__sidebar" v-if="showSidebar">
|
||||
<portal-target name="desktop-nav" />
|
||||
</div>
|
||||
|
||||
@ -49,7 +49,7 @@
|
||||
<slot />
|
||||
</div>
|
||||
</main>
|
||||
<div class="app__page-navigation">
|
||||
<div class="app__page-navigation" v-if="showSidebar">
|
||||
<div class="app__inner">
|
||||
<page-navigation />
|
||||
</div>
|
||||
@ -123,6 +123,13 @@ import PageNavigation from '@/components/PageNavigation'
|
||||
// import GithubButton from 'vue-github-button'
|
||||
|
||||
export default {
|
||||
props: {
|
||||
showSidebar: {
|
||||
type: Boolean,
|
||||
default: true,
|
||||
},
|
||||
},
|
||||
|
||||
components: {
|
||||
Icon,
|
||||
PageNavigation,
|
||||
|
@ -8,7 +8,7 @@ $menuBreakPoint: 800px;
|
||||
&__navigation {
|
||||
position: fixed;
|
||||
display: flex;
|
||||
z-index: 1;
|
||||
z-index: 2;
|
||||
top: 0;
|
||||
width: 100%;
|
||||
height: $navHeight;
|
||||
@ -33,6 +33,8 @@ $menuBreakPoint: 800px;
|
||||
|
||||
&__content {
|
||||
display: flex;
|
||||
position: relative;
|
||||
z-index: 1;
|
||||
}
|
||||
|
||||
&__name {
|
||||
@ -163,15 +165,15 @@ $menuBreakPoint: 800px;
|
||||
}
|
||||
}
|
||||
|
||||
&__inner {
|
||||
margin: 0 auto;
|
||||
max-width: 50rem;
|
||||
padding: 0 1rem;
|
||||
// &__inner {
|
||||
// margin: 0 auto;
|
||||
// max-width: 50rem;
|
||||
// padding: 0 1rem;
|
||||
|
||||
@media (min-width: $mobileBreakPoint) {
|
||||
padding: 0 2rem;
|
||||
}
|
||||
}
|
||||
// @media (min-width: $mobileBreakPoint) {
|
||||
// padding: 0 2rem;
|
||||
// }
|
||||
// }
|
||||
|
||||
&__link-group {
|
||||
margin-bottom: 1rem;
|
||||
|
@ -1,7 +1,5 @@
|
||||
- title: Overview
|
||||
items:
|
||||
- title: Introduction
|
||||
link: /
|
||||
- title: Installation
|
||||
link: /overview/installation
|
||||
- title: Upgrade Guide
|
||||
|
95
docs/src/pages/index.vue
Normal file
95
docs/src/pages/index.vue
Normal file
@ -0,0 +1,95 @@
|
||||
<template>
|
||||
<Layout :show-sidebar="false">
|
||||
<app-section>
|
||||
<h1>
|
||||
Headless WYSIWYG Text Editor
|
||||
</h1>
|
||||
<p>
|
||||
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*.
|
||||
</p>
|
||||
<p>
|
||||
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.
|
||||
</p>
|
||||
</app-section>
|
||||
|
||||
<app-section>
|
||||
<demo name="Examples/CollaborativeEditing" :show-source="false" inline />
|
||||
</app-section>
|
||||
|
||||
<app-section>
|
||||
<h2>
|
||||
Features
|
||||
</h2>
|
||||
|
||||
<h3>
|
||||
Headless
|
||||
</h3>
|
||||
<p>
|
||||
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, styling and behaviour.
|
||||
</p>
|
||||
|
||||
<h3>
|
||||
Framework-agnostic
|
||||
</h3>
|
||||
<p>
|
||||
No matter what framework you use, you’ll enjoy tiptap. Out of the box, it works with plain JavaScript and Vue.js, but it’s also possible to use it in [React](/guide/getting-started/react), Svelte and others.
|
||||
</p>
|
||||
|
||||
<h3>
|
||||
TypeScript
|
||||
</h3>
|
||||
<p>
|
||||
tiptap 2 is written in TypeScript. That helps us to find bugs early and gives you a nice autocomplete for the API (if your IDE supports that) on top of the extensive human written documentation.
|
||||
</p>
|
||||
|
||||
<h3>
|
||||
Collaborative
|
||||
</h3>
|
||||
<p>
|
||||
Real-time collaboration, syncing between different devices and working offline used to be hard. We provide everything you need to keep everything in sync, conflict-free with the power of [Y.js](https://github.com/yjs/yjs). Our production-grade setup requires less than 20 lines of code.
|
||||
</p>
|
||||
|
||||
<h3>
|
||||
Community
|
||||
</h3>
|
||||
<p>
|
||||
Over the years, a lovely community has grown around tiptap. There’s so much content shared, so many people helping out in issues and a ton of community extensions, you’ll be surprised how much that can help.
|
||||
</p>
|
||||
</app-section>
|
||||
|
||||
<app-section>
|
||||
<h2>
|
||||
Who uses tiptap?
|
||||
</h2>
|
||||
- [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)
|
||||
- [DocIQ](https://www.dociq.io)
|
||||
- [ycode](https://www.ycode.com/)
|
||||
- [Scrumpy](https://www.scrumpy.io)
|
||||
- … and [many more](https://github.com/ueberdosis/tiptap/network/dependents?package_id=UGFja2FnZS0xMzE5OTg0ODc%3D)
|
||||
</app-section>
|
||||
|
||||
<app-section>
|
||||
<h2>
|
||||
License
|
||||
</h2>
|
||||
<p>
|
||||
tiptap is licensed under [MIT](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md), 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.
|
||||
</p>
|
||||
</app-section>
|
||||
</Layout>
|
||||
</template>
|
||||
|
||||
<script>
|
||||
import AppSection from '@/components/AppSection'
|
||||
|
||||
export default {
|
||||
components: {
|
||||
AppSection,
|
||||
},
|
||||
}
|
||||
</script>
|
@ -1,8 +1,10 @@
|
||||
<template>
|
||||
<Layout>
|
||||
<div class="doc-page">
|
||||
<VueRemarkContent class="doc-page__markdown" />
|
||||
</div>
|
||||
<app-section>
|
||||
<div class="doc-page">
|
||||
<VueRemarkContent class="doc-page__markdown" />
|
||||
</div>
|
||||
</app-section>
|
||||
</Layout>
|
||||
</template>
|
||||
|
||||
@ -19,7 +21,13 @@ query($path: String!) {
|
||||
</page-query>
|
||||
|
||||
<script>
|
||||
import AppSection from '@/components/AppSection'
|
||||
|
||||
export default {
|
||||
components: {
|
||||
AppSection,
|
||||
},
|
||||
|
||||
metaInfo() {
|
||||
return {
|
||||
title: this.$page?.docPage?.title,
|
||||
|
Loading…
Reference in New Issue
Block a user