From 13f95e2688fce8bb089cd22ceb4364203f03f1b0 Mon Sep 17 00:00:00 2001 From: Hans Pagel Date: Tue, 1 Dec 2020 17:36:27 +0100 Subject: [PATCH 1/4] docs: update content --- docs/src/docPages/guide/node-views.md | 2 +- docs/src/links.yaml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/src/docPages/guide/node-views.md b/docs/src/docPages/guide/node-views.md index ee539221..6c2f90ad 100644 --- a/docs/src/docPages/guide/node-views.md +++ b/docs/src/docPages/guide/node-views.md @@ -1,4 +1,4 @@ -# Advanced node views +# Complex node views ## toc diff --git a/docs/src/links.yaml b/docs/src/links.yaml index 8101f44c..c61a1719 100644 --- a/docs/src/links.yaml +++ b/docs/src/links.yaml @@ -51,7 +51,7 @@ link: /guide/store-content - title: Build extensions link: /guide/build-extensions - - title: Define node views + - title: Complex node views link: /guide/node-views draft: true - title: Working with TypeScript From 9c82356184ebaa4d240c6e9a89be5b2c8fec3d3f Mon Sep 17 00:00:00 2001 From: Hans Pagel Date: Wed, 2 Dec 2020 10:53:30 +0100 Subject: [PATCH 2/4] add new dummy pages --- docs/src/docPages/api/extensions/suggestion.md | 7 +++++++ docs/src/docPages/api/nodes/table.md | 3 +++ docs/src/links.yaml | 6 ++++++ 3 files changed, 16 insertions(+) create mode 100644 docs/src/docPages/api/extensions/suggestion.md create mode 100644 docs/src/docPages/api/nodes/table.md diff --git a/docs/src/docPages/api/extensions/suggestion.md b/docs/src/docPages/api/extensions/suggestion.md new file mode 100644 index 00000000..af95f298 --- /dev/null +++ b/docs/src/docPages/api/extensions/suggestion.md @@ -0,0 +1,7 @@ +# Suggestion + +TODO + +- mentions +- hashtags +- emojis diff --git a/docs/src/docPages/api/nodes/table.md b/docs/src/docPages/api/nodes/table.md new file mode 100644 index 00000000..e29c9d18 --- /dev/null +++ b/docs/src/docPages/api/nodes/table.md @@ -0,0 +1,3 @@ +# Table + + TODO diff --git a/docs/src/links.yaml b/docs/src/links.yaml index c61a1719..a3f266bf 100644 --- a/docs/src/links.yaml +++ b/docs/src/links.yaml @@ -91,6 +91,9 @@ link: /api/nodes/ordered-list - title: Paragraph link: /api/nodes/paragraph + - title: Table + link: /api/nodes/table + draft: true - title: TaskList link: /api/nodes/task-list - title: TaskItem @@ -135,6 +138,9 @@ link: /api/extensions/gapcursor - title: History link: /api/extensions/history + - title: Suggestions + link: /api/extensions/suggestions + draft: true - title: TextAlign link: /api/extensions/text-align - title: Typography From ef6b403b9472be4d8f85111562ece07c24bd8bf5 Mon Sep 17 00:00:00 2001 From: Hans Pagel Date: Wed, 2 Dec 2020 11:41:00 +0100 Subject: [PATCH 3/4] docs: fix broken link --- docs/src/links.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/src/links.yaml b/docs/src/links.yaml index a3f266bf..3908471b 100644 --- a/docs/src/links.yaml +++ b/docs/src/links.yaml @@ -138,8 +138,8 @@ link: /api/extensions/gapcursor - title: History link: /api/extensions/history - - title: Suggestions - link: /api/extensions/suggestions + - title: Suggestion + link: /api/extensions/suggestion draft: true - title: TextAlign link: /api/extensions/text-align From 672bf4f469eb45b53918695fc8b5d98ce0d32dd9 Mon Sep 17 00:00:00 2001 From: Hans Pagel Date: Wed, 2 Dec 2020 11:41:25 +0100 Subject: [PATCH 4/4] docs: update the hocuspocus documentation --- docs/src/docPages/guide/collaborative-editing.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/src/docPages/guide/collaborative-editing.md b/docs/src/docPages/guide/collaborative-editing.md index 29ad3b94..90e99c00 100644 --- a/docs/src/docPages/guide/collaborative-editing.md +++ b/docs/src/docPages/guide/collaborative-editing.md @@ -244,7 +244,7 @@ server.listen() ``` ### Send it to an API -To pass the updated documents to an API, or to a database, you can use the `onChange` hook, which is executed when a document changes. With the `debounce` setting you can slow down the execution, with the `debounceMaximum` setting you can make sure the content is sent at least every few seconds: +To pass the updated documents to an API, or to a database, you can use the `onChange` hook, which is executed when a document changes. With the `debounce` setting you can slow down the execution, with the `debounceMaxWait` setting you can make sure the content is sent at least every few seconds: ```js import { Server } from '@hocuspocus/server' @@ -254,7 +254,7 @@ const server = Server.configure({ debounce: 2000, // maximum time to wait (in milliseconds) - debounceMaximum: 10000, + debounceMaxWait: 10000, // executed when the document is changed onChange(data) {