From 4d297e9116053a089ed33afe00b2565a7467406c Mon Sep 17 00:00:00 2001 From: Hans Pagel Date: Tue, 18 Aug 2020 21:47:04 +0200 Subject: [PATCH] group all content files by section --- docs/src/demos/Basic/index.spec.js | 2 +- docs/src/docPages/{ => api}/commands.md | 0 docs/src/docPages/{ => api}/editor.md | 0 docs/src/docPages/{ => api}/events.md | 0 docs/src/docPages/{ => api}/extensions.md | 0 docs/src/docPages/{ => api}/schema.md | 0 docs/src/docPages/{ => examples}/basic.md | 2 + .../{ => getting-started}/installation.md | 0 .../{ => getting-started}/introduction.md | 0 .../docPages/getting-started/upgrade-guide.md | 3 ++ .../docPages/{ => guide}/build-your-editor.md | 0 .../src/docPages/{ => guide}/configuration.md | 0 docs/src/docPages/guide/custom-extensions.md | 1 + docs/src/docPages/guide/custom-styling.md | 1 + docs/src/docPages/{ => guide}/get-content.md | 0 .../docPages/{ => guide}/getting-started.md | 0 docs/src/docPages/guide/use-vue-components.md | 1 + docs/src/links.yaml | 48 +++++++------------ 18 files changed, 25 insertions(+), 33 deletions(-) rename docs/src/docPages/{ => api}/commands.md (100%) rename docs/src/docPages/{ => api}/editor.md (100%) rename docs/src/docPages/{ => api}/events.md (100%) rename docs/src/docPages/{ => api}/extensions.md (100%) rename docs/src/docPages/{ => api}/schema.md (100%) rename docs/src/docPages/{ => examples}/basic.md (70%) rename docs/src/docPages/{ => getting-started}/installation.md (100%) rename docs/src/docPages/{ => getting-started}/introduction.md (100%) create mode 100644 docs/src/docPages/getting-started/upgrade-guide.md rename docs/src/docPages/{ => guide}/build-your-editor.md (100%) rename docs/src/docPages/{ => guide}/configuration.md (100%) create mode 100644 docs/src/docPages/guide/custom-extensions.md create mode 100644 docs/src/docPages/guide/custom-styling.md rename docs/src/docPages/{ => guide}/get-content.md (100%) rename docs/src/docPages/{ => guide}/getting-started.md (100%) create mode 100644 docs/src/docPages/guide/use-vue-components.md diff --git a/docs/src/demos/Basic/index.spec.js b/docs/src/demos/Basic/index.spec.js index 5a350e28..30e55913 100644 --- a/docs/src/demos/Basic/index.spec.js +++ b/docs/src/demos/Basic/index.spec.js @@ -1,6 +1,6 @@ context('basic', () => { beforeEach(() => { - cy.visit('/basic') + cy.visit('/examples/basic') }) describe('export', () => { diff --git a/docs/src/docPages/commands.md b/docs/src/docPages/api/commands.md similarity index 100% rename from docs/src/docPages/commands.md rename to docs/src/docPages/api/commands.md diff --git a/docs/src/docPages/editor.md b/docs/src/docPages/api/editor.md similarity index 100% rename from docs/src/docPages/editor.md rename to docs/src/docPages/api/editor.md diff --git a/docs/src/docPages/events.md b/docs/src/docPages/api/events.md similarity index 100% rename from docs/src/docPages/events.md rename to docs/src/docPages/api/events.md diff --git a/docs/src/docPages/extensions.md b/docs/src/docPages/api/extensions.md similarity index 100% rename from docs/src/docPages/extensions.md rename to docs/src/docPages/api/extensions.md diff --git a/docs/src/docPages/schema.md b/docs/src/docPages/api/schema.md similarity index 100% rename from docs/src/docPages/schema.md rename to docs/src/docPages/api/schema.md diff --git a/docs/src/docPages/basic.md b/docs/src/docPages/examples/basic.md similarity index 70% rename from docs/src/docPages/basic.md rename to docs/src/docPages/examples/basic.md index 871d1799..7ee4a918 100644 --- a/docs/src/docPages/basic.md +++ b/docs/src/docPages/examples/basic.md @@ -1 +1,3 @@ +# Basic + \ No newline at end of file diff --git a/docs/src/docPages/installation.md b/docs/src/docPages/getting-started/installation.md similarity index 100% rename from docs/src/docPages/installation.md rename to docs/src/docPages/getting-started/installation.md diff --git a/docs/src/docPages/introduction.md b/docs/src/docPages/getting-started/introduction.md similarity index 100% rename from docs/src/docPages/introduction.md rename to docs/src/docPages/getting-started/introduction.md diff --git a/docs/src/docPages/getting-started/upgrade-guide.md b/docs/src/docPages/getting-started/upgrade-guide.md new file mode 100644 index 00000000..8c8e6d1f --- /dev/null +++ b/docs/src/docPages/getting-started/upgrade-guide.md @@ -0,0 +1,3 @@ +# Upgrade Guide + +## Upgrading from 1.x to 2.x \ No newline at end of file diff --git a/docs/src/docPages/build-your-editor.md b/docs/src/docPages/guide/build-your-editor.md similarity index 100% rename from docs/src/docPages/build-your-editor.md rename to docs/src/docPages/guide/build-your-editor.md diff --git a/docs/src/docPages/configuration.md b/docs/src/docPages/guide/configuration.md similarity index 100% rename from docs/src/docPages/configuration.md rename to docs/src/docPages/guide/configuration.md diff --git a/docs/src/docPages/guide/custom-extensions.md b/docs/src/docPages/guide/custom-extensions.md new file mode 100644 index 00000000..84c4caee --- /dev/null +++ b/docs/src/docPages/guide/custom-extensions.md @@ -0,0 +1 @@ +# Custom Extensions \ No newline at end of file diff --git a/docs/src/docPages/guide/custom-styling.md b/docs/src/docPages/guide/custom-styling.md new file mode 100644 index 00000000..360d1d22 --- /dev/null +++ b/docs/src/docPages/guide/custom-styling.md @@ -0,0 +1 @@ +# Custom Styling \ No newline at end of file diff --git a/docs/src/docPages/get-content.md b/docs/src/docPages/guide/get-content.md similarity index 100% rename from docs/src/docPages/get-content.md rename to docs/src/docPages/guide/get-content.md diff --git a/docs/src/docPages/getting-started.md b/docs/src/docPages/guide/getting-started.md similarity index 100% rename from docs/src/docPages/getting-started.md rename to docs/src/docPages/guide/getting-started.md diff --git a/docs/src/docPages/guide/use-vue-components.md b/docs/src/docPages/guide/use-vue-components.md new file mode 100644 index 00000000..312a0889 --- /dev/null +++ b/docs/src/docPages/guide/use-vue-components.md @@ -0,0 +1 @@ +# Use Vue Components \ No newline at end of file diff --git a/docs/src/links.yaml b/docs/src/links.yaml index ad82dddf..d8e80b75 100644 --- a/docs/src/links.yaml +++ b/docs/src/links.yaml @@ -1,49 +1,33 @@ - title: Getting Started items: - title: Introduction 🚧 - link: /introduction/ + link: /getting-started/introduction/ - title: Installation ✅ - link: /installation/ + link: /getting-started/installation/ - title: Upgrade Guide ❌ - link: /upgrade-guide/ + link: /getting-started/upgrade-guide/ - title: Guide items: - title: Getting started ✅ - link: /getting-started/ + link: /guide/getting-started/ - title: Configuration 🚧 - link: /configuration/ + link: /guide/configuration/ - title: Build your editor 🚧 - link: /build-your-editor/ + link: /guide/build-your-editor/ - title: Custom styling ❌ - link: /custom-styling/ + link: /guide/custom-styling/ - title: Get content 🚧 - link: /get-content/ + link: /guide/get-content/ - title: Custom extensions ❌ - link: /advanced-notes/ + link: /guide/custom-extensions/ - title: Use Vue Components ❌ - link: /render-vue-components/ - -# - title: Vue -# items: -# - title: Use tiptap with Vue.js 🚧 -# link: /basic-vue-example/ -# - title: Advanced Example -# link: /advanced-vue-example/ -# - title: Render Vue Components -# link: /render-vue-components/ - -# - title: React -# items: -# - title: React -# link: /react/ -# - title: Render React Components -# link: /advanced-react-example/ + link: /guide/use-vue-components/ - title: Examples items: - title: Basic - link: basic + link: /examples/basic - title: Menu Bubble link: /Menu Bubble/ - title: Floating Menu @@ -90,9 +74,9 @@ - title: API items: - title: Editor - link: /editor/ + link: /api/editor/ - title: Extensions 🚧 - link: /extensions/ + link: /api/extensions/ items: - title: Blockquote link: /api/extensions/blockquote @@ -137,8 +121,8 @@ - title: Underline link: /api/extensions/underline - title: Commands - link: /commands/ + link: /api/commands/ - title: Events - link: /events/ + link: /api/events/ - title: Schema - link: /schema/ \ No newline at end of file + link: /api/schema/ \ No newline at end of file