diff --git a/docs/src/docPages/api/overview.md b/docs/src/docPages/api/concept.md similarity index 99% rename from docs/src/docPages/api/overview.md rename to docs/src/docPages/api/concept.md index 38db90ba..920750ca 100644 --- a/docs/src/docPages/api/overview.md +++ b/docs/src/docPages/api/concept.md @@ -1,4 +1,4 @@ -# Overview +# Concept tiptap is a friendly wrapper around [ProseMirror](https://ProseMirror.net). Although tiptap tries to hide most of the complexity of ProseMirror, it’s built on top of its APIs and we recommend you to read through the [ProseMirror Guide](https://ProseMirror.net/docs/guide/) for advanced usage. ### Structure diff --git a/docs/src/docPages/api/marks.md b/docs/src/docPages/api/marks.md index 7a58c3d6..969f983f 100644 --- a/docs/src/docPages/api/marks.md +++ b/docs/src/docPages/api/marks.md @@ -4,6 +4,8 @@ ## Introduction +TODO + ## List of supported marks | Title | Default Extension | Source Code | | ---------------------------------- | ----------------- | -------------------------------------------------------------------------------------------- | diff --git a/docs/src/docPages/api/nodes.md b/docs/src/docPages/api/nodes.md index c2c44f22..2a6728d0 100644 --- a/docs/src/docPages/api/nodes.md +++ b/docs/src/docPages/api/nodes.md @@ -4,6 +4,8 @@ ## Introduction +TODO + ## List of supported nodes | Title | Default Extension | Source Code | | -------------------------------------------- | ----------------- | ------------------------------------------------------------------------------------------------- | diff --git a/docs/src/docPages/api/nodes/mention.md b/docs/src/docPages/api/nodes/mention.md index f9b3e0a0..4f40ec4e 100644 --- a/docs/src/docPages/api/nodes/mention.md +++ b/docs/src/docPages/api/nodes/mention.md @@ -13,6 +13,16 @@ npm install @tiptap/extension-mention yarn add @tiptap/extension-mention ``` +## Dependencies +TODO + +* tippy.js + +## Rendering +TODO + +* @tiptap/vue + ## Settings | Option | Type | Default | Description | | -------------- | -------- | ------- | --------------------------------------------------------------------- | diff --git a/docs/src/links.yaml b/docs/src/links.yaml index 16a07567..73023311 100644 --- a/docs/src/links.yaml +++ b/docs/src/links.yaml @@ -44,7 +44,7 @@ - title: Getting started link: /guide/getting-started items: - - title: Vue CLI + - title: Vue.js 2 link: /guide/getting-started/vue-cli skip: true - title: Nuxt.js @@ -100,10 +100,12 @@ - title: API items: - - title: Overview + - title: Concept link: /api/overview - title: Editor link: /api/editor + - title: Commands + link: /api/commands - title: Nodes link: /api/nodes items: @@ -201,20 +203,18 @@ link: /api/extensions/text-align - title: Typography link: /api/extensions/typography - - title: Commands - link: /api/commands - - title: Events - link: /api/events - - title: Schema - link: /api/schema - - title: Keyboard Shortcuts - link: /api/keyboard-shortcuts - title: Utilities link: /api/utilities redirect: /api/utilities/suggestion items: - title: Suggestion link: /api/utilities/suggestion + - title: Events + link: /api/events + - title: Schema + link: /api/schema + - title: Keyboard Shortcuts + link: /api/keyboard-shortcuts - title: Links items: