From 53d20a454ade5b14a4d8247029614ea2006743a4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Philipp=20Ku=CC=88hn?= Date: Sat, 18 Apr 2020 20:39:48 +0200 Subject: [PATCH] move some pages --- docs/src/data/links.yaml | 24 ++++++++++++------- docs/src/data/posts/commands.md | 1 + docs/src/data/posts/editor.md | 5 ++++ docs/src/data/posts/events.md | 1 + docs/src/data/posts/extensions.md | 1 + .../posts/{install.md => installation.md} | 2 +- docs/src/data/posts/renderless.md | 3 +++ docs/src/layouts/App/base.scss | 8 +++++++ docs/src/layouts/App/prism.scss | 1 + docs/src/templates/DocPage/style.scss | 5 +++- 10 files changed, 40 insertions(+), 11 deletions(-) create mode 100644 docs/src/data/posts/commands.md create mode 100644 docs/src/data/posts/editor.md create mode 100644 docs/src/data/posts/events.md create mode 100644 docs/src/data/posts/extensions.md rename docs/src/data/posts/{install.md => installation.md} (95%) create mode 100644 docs/src/data/posts/renderless.md diff --git a/docs/src/data/links.yaml b/docs/src/data/links.yaml index 03218d94..954f2cf4 100644 --- a/docs/src/data/links.yaml +++ b/docs/src/data/links.yaml @@ -1,13 +1,7 @@ - title: Getting Started items: - - title: Install - link: /install/ - - title: Basic Example - link: /basic-example/ - - title: Advanced Example - link: /advanced-example/ - - title: React - link: /react/ + - title: Installation + link: /installation/ - title: Core Concepts items: @@ -20,4 +14,16 @@ - title: Commands link: /commands/ - title: Events - link: /events/ \ No newline at end of file + link: /events/ + +- title: Vue + items: + - title: Basic Example + link: /basic-example/ + - title: Advanced Example + link: /advanced-example/ + +- title: React + items: + - title: React + link: /react/ \ No newline at end of file diff --git a/docs/src/data/posts/commands.md b/docs/src/data/posts/commands.md new file mode 100644 index 00000000..e6827429 --- /dev/null +++ b/docs/src/data/posts/commands.md @@ -0,0 +1 @@ +# Commands \ No newline at end of file diff --git a/docs/src/data/posts/editor.md b/docs/src/data/posts/editor.md new file mode 100644 index 00000000..8df1f9f9 --- /dev/null +++ b/docs/src/data/posts/editor.md @@ -0,0 +1,5 @@ +# 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 diff --git a/docs/src/data/posts/events.md b/docs/src/data/posts/events.md new file mode 100644 index 00000000..cbf94584 --- /dev/null +++ b/docs/src/data/posts/events.md @@ -0,0 +1 @@ +# Events \ No newline at end of file diff --git a/docs/src/data/posts/extensions.md b/docs/src/data/posts/extensions.md new file mode 100644 index 00000000..3dd290d4 --- /dev/null +++ b/docs/src/data/posts/extensions.md @@ -0,0 +1 @@ +# Extensions \ No newline at end of file diff --git a/docs/src/data/posts/install.md b/docs/src/data/posts/installation.md similarity index 95% rename from docs/src/data/posts/install.md rename to docs/src/data/posts/installation.md index 5db40ac1..b5a2c021 100644 --- a/docs/src/data/posts/install.md +++ b/docs/src/data/posts/installation.md @@ -1,4 +1,4 @@ -# Install +# Installation ```bash # Using npm diff --git a/docs/src/data/posts/renderless.md b/docs/src/data/posts/renderless.md new file mode 100644 index 00000000..c3d22836 --- /dev/null +++ b/docs/src/data/posts/renderless.md @@ -0,0 +1,3 @@ +# Renderless + +tiptap comes without any CSS. \ No newline at end of file diff --git a/docs/src/layouts/App/base.scss b/docs/src/layouts/App/base.scss index b85098f1..d3e2f556 100644 --- a/docs/src/layouts/App/base.scss +++ b/docs/src/layouts/App/base.scss @@ -72,6 +72,14 @@ a { text-decoration: none; } +code { + font-family: 'JetBrainsMono', monospace; + background-color: rgba($colorBlack, 0.05); + padding: 0.1rem 0.5rem; + border-radius: 0.25rem; + color: rgba($colorBlack, 0.7); +} + .is-active { background: black; color: white; diff --git a/docs/src/layouts/App/prism.scss b/docs/src/layouts/App/prism.scss index 4cbd1d52..cba24875 100644 --- a/docs/src/layouts/App/prism.scss +++ b/docs/src/layouts/App/prism.scss @@ -23,6 +23,7 @@ code[class*="language-"], pre[class*="language-"] { font-size: 1em; line-height: 1.8; tab-size: 2; + padding: 0; } code[class*="language-"]::-moz-selection, pre[class*="language-"]::-moz-selection, diff --git a/docs/src/templates/DocPage/style.scss b/docs/src/templates/DocPage/style.scss index 5eb78a38..4d6c0eaf 100644 --- a/docs/src/templates/DocPage/style.scss +++ b/docs/src/templates/DocPage/style.scss @@ -1,7 +1,10 @@ .doc-page { &__markdown ::v-deep { - h1, + h1 { + font-weight: 400; + } + h2, h3, h4,