From 170b9b8d64f4028b34f595d0cc46935c501c1c58 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Philipp=20Ku=CC=88hn?= Date: Wed, 21 Apr 2021 11:03:33 +0200 Subject: [PATCH] docs: update content --- docs/src/docPages/api/commands.md | 89 +++++++++---------- docs/src/docPages/api/commands/blur.md | 3 + .../api/commands/create-paragraph-near.md | 3 + .../src/docPages/api/commands/delete-range.md | 3 + .../docPages/api/commands/delete-selection.md | 3 + docs/src/docPages/api/commands/enter.md | 3 + docs/src/docPages/api/commands/exit-code.md | 3 + .../api/commands/extend-mark-range.md | 3 + docs/src/docPages/api/commands/focus.md | 3 + .../docPages/api/commands/join-backward.md | 3 + .../src/docPages/api/commands/join-forward.md | 3 + .../api/commands/keyboard-shortcut.md | 3 + .../docPages/api/commands/lift-empty-block.md | 3 + .../docPages/api/commands/lift-list-item.md | 3 + docs/src/docPages/api/commands/lift.md | 3 + .../docPages/api/commands/newline-in-code.md | 3 + .../docPages/api/commands/replace-range.md | 3 + docs/src/docPages/api/commands/replace.md | 3 + .../docPages/api/commands/reset-attributes.md | 3 + .../docPages/api/commands/scroll-into-view.md | 3 + docs/src/docPages/api/commands/select-all.md | 3 + .../api/commands/select-node-backward.md | 3 + .../api/commands/select-node-forward.md | 3 + .../api/commands/select-parent-node.md | 3 + docs/src/docPages/api/commands/set-mark.md | 3 + docs/src/docPages/api/commands/set-node.md | 3 + .../docPages/api/commands/sink-list-item.md | 3 + docs/src/docPages/api/commands/split-block.md | 3 + .../docPages/api/commands/split-list-item.md | 3 + docs/src/docPages/api/commands/toggle-list.md | 3 + docs/src/docPages/api/commands/toggle-mark.md | 3 + docs/src/docPages/api/commands/toggle-node.md | 3 + docs/src/docPages/api/commands/toggle-wrap.md | 3 + .../docPages/api/commands/undo-input-rule.md | 3 + .../docPages/api/commands/unset-all-marks.md | 3 + docs/src/docPages/api/commands/unset-mark.md | 3 + docs/src/docPages/api/commands/wrapInList.md | 3 + docs/src/links.yaml | 81 +++++++++++++++-- 38 files changed, 228 insertions(+), 50 deletions(-) create mode 100644 docs/src/docPages/api/commands/blur.md create mode 100644 docs/src/docPages/api/commands/create-paragraph-near.md create mode 100644 docs/src/docPages/api/commands/delete-range.md create mode 100644 docs/src/docPages/api/commands/delete-selection.md create mode 100644 docs/src/docPages/api/commands/enter.md create mode 100644 docs/src/docPages/api/commands/exit-code.md create mode 100644 docs/src/docPages/api/commands/extend-mark-range.md create mode 100644 docs/src/docPages/api/commands/focus.md create mode 100644 docs/src/docPages/api/commands/join-backward.md create mode 100644 docs/src/docPages/api/commands/join-forward.md create mode 100644 docs/src/docPages/api/commands/keyboard-shortcut.md create mode 100644 docs/src/docPages/api/commands/lift-empty-block.md create mode 100644 docs/src/docPages/api/commands/lift-list-item.md create mode 100644 docs/src/docPages/api/commands/lift.md create mode 100644 docs/src/docPages/api/commands/newline-in-code.md create mode 100644 docs/src/docPages/api/commands/replace-range.md create mode 100644 docs/src/docPages/api/commands/replace.md create mode 100644 docs/src/docPages/api/commands/reset-attributes.md create mode 100644 docs/src/docPages/api/commands/scroll-into-view.md create mode 100644 docs/src/docPages/api/commands/select-all.md create mode 100644 docs/src/docPages/api/commands/select-node-backward.md create mode 100644 docs/src/docPages/api/commands/select-node-forward.md create mode 100644 docs/src/docPages/api/commands/select-parent-node.md create mode 100644 docs/src/docPages/api/commands/set-mark.md create mode 100644 docs/src/docPages/api/commands/set-node.md create mode 100644 docs/src/docPages/api/commands/sink-list-item.md create mode 100644 docs/src/docPages/api/commands/split-block.md create mode 100644 docs/src/docPages/api/commands/split-list-item.md create mode 100644 docs/src/docPages/api/commands/toggle-list.md create mode 100644 docs/src/docPages/api/commands/toggle-mark.md create mode 100644 docs/src/docPages/api/commands/toggle-node.md create mode 100644 docs/src/docPages/api/commands/toggle-wrap.md create mode 100644 docs/src/docPages/api/commands/undo-input-rule.md create mode 100644 docs/src/docPages/api/commands/unset-all-marks.md create mode 100644 docs/src/docPages/api/commands/unset-mark.md create mode 100644 docs/src/docPages/api/commands/wrapInList.md diff --git a/docs/src/docPages/api/commands.md b/docs/src/docPages/api/commands.md index 9fc1a16a..cb554aad 100644 --- a/docs/src/docPages/api/commands.md +++ b/docs/src/docPages/api/commands.md @@ -161,55 +161,54 @@ Have a look at all of the core commands listed below. They should give you a goo | .setContent() | Replace the whole document with new content. | [More](/api/commands/set-content) | ### Nodes & Marks -| Command | Description | -| ----------------------- | --------------------------------------------------------- | -| .clearNodes() | Normalize nodes to a simple paragraph. | -| .createParagraphNear() | Create a paragraph nearby. | -| .exitCode() | Exit from a code block. | -| .extendMarkRange() | Extends the text selection to the current mark. | -| .joinBackward() | Join two nodes backward. | -| .joinForward() | Join two nodes forward. | -| .lift() | Removes an existing wrap. | -| .liftEmptyBlock() | Lift block if empty. | -| .newlineInCode() | Add a newline character in code. | -| .replace() | Replaces text with a node. | -| .replaceRange() | Replaces text with a node within a range. | -| .resetAttributes() | Resets some node or mark attributes to the default value. | -| .selectParentNode() | Select the parent node. | -| .setMark() | Add a mark with new attributes. | -| .setNode() | Replace a given range with a node. | -| .splitBlock() | Forks a new node from an existing node. | -| .toggleMark() | Toggle a mark on and off. | -| .toggleNode() | Toggle a node with another node. | -| .toggleWrap() | Wraps nodes in another node, or removes an existing wrap. | -| .undoInputRule() | Undo an input rule. | -| .unsetAllMarks() | Remove all marks in the current selection. | -| .unsetMark() | Remove a mark in the current selection. | -| .updateAttributes() | Update attributes of a node or mark. | +| Command | Description | Links | +| ----------------------- | --------------------------------------------------------- | ------------------------------------ | +| .clearNodes() | Normalize nodes to a simple paragraph. | [More](/api/commands/clear-nodes) | +| .createParagraphNear() | Create a paragraph nearby. | [More](/api/commands/create-paragraph-near) | +| .extendMarkRange() | Extends the text selection to the current mark. | [More](/api/commands/extend-mark-range) | +| .exitCode() | Exit from a code block. | [More](/api/commands/exit-code) | +| .joinBackward() | Join two nodes backward. | [More](/api/commands/join-backward) | +| .joinForward() | Join two nodes forward. | [More](/api/commands/join-forward) | +| .lift() | Removes an existing wrap. | [More](/api/commands/lift) | +| .liftEmptyBlock() | Lift block if empty. | [More](/api/commands/lift-empty-block) | +| .newlineInCode() | Add a newline character in code. | [More](/api/commands/newline-in-code) | +| .replace() | Replaces text with a node. | [More](/api/commands/replace) | +| .replaceRange() | Replaces text with a node within a range. | [More](/api/commands/replace-range) | +| .resetAttributes() | Resets some node or mark attributes to the default value. | [More](/api/commands/reset-attributes) | +| .setMark() | Add a mark with new attributes. | [More](/api/commands/set-mark) | +| .setNode() | Replace a given range with a node. | [More](/api/commands/set-node) | +| .splitBlock() | Forks a new node from an existing node. | [More](/api/commands/split-block) | +| .toggleMark() | Toggle a mark on and off. | [More](/api/commands/toggle-mark) | +| .toggleNode() | Toggle a node with another node. | [More](/api/commands/toggle-node) | +| .toggleWrap() | Wraps nodes in another node, or removes an existing wrap. | [More](/api/commands/toggle-wrap) | +| .undoInputRule() | Undo an input rule. | [More](/api/commands/undo-input-rule) | +| .unsetAllMarks() | Remove all marks in the current selection. | [More](/api/commands/unset-all-marks) | +| .unsetMark() | Remove a mark in the current selection. | [More](/api/commands/unset-mark) | +| .updateAttributes() | Update attributes of a node or mark. | [More](/api/commands/update-attributes) | ### Lists -| Command | Description | -| ---------------- | ------------------------------------------- | -| .liftListItem() | Lift the list item into a wrapping list. | -| .sinkListItem() | Sink the list item down into an inner list. | -| .splitListItem() | Splits one list item into two list items. | -| .toggleList() | Toggle between different list types. | -| .wrapInList() | Wrap a node in a list. | +| Command | Description | Links | +| ---------------- | ------------------------------------------- | ------------------------------------ | +| .liftListItem() | Lift the list item into a wrapping list. | [More](/api/commands/lift-list-item) | +| .sinkListItem() | Sink the list item down into an inner list. | [More](/api/commands/sink-list-item) | +| .splitListItem() | Splits one list item into two list items. | [More](/api/commands/split-list-item) | +| .toggleList() | Toggle between different list types. | [More](/api/commands/toggle-list) | +| .wrapInList() | Wrap a node in a list. | [More](/api/commands/wrap-in-list) | ### Selection -| Command | Description | -| --------------------- | --------------------------------------- | -| .blur() | Removes focus from the editor. | -| .deleteRange() | Delete a given range. | -| .deleteSelection() | Delete the selection, if there is one. | -| .enter() | Trigger enter. | -| .focus() | Focus the editor at the given position. | -| .keyboardShortcut() | Trigger a keyboard shortcut. | -| .scrollIntoView() | Scroll the selection into view. | -| .selectAll() | Select the whole document. | -| .selectNodeBackward() | Select a node backward. | -| .selectNodeForward() | Select a node forward. | -| .selectParentNode() | Select the parent node. | +| Command | Description | Links | +| --------------------- | --------------------------------------- | ------------------------------------ | +| .blur() | Removes focus from the editor. | [More](/api/commands/blur) | +| .deleteRange() | Delete a given range. | [More](/api/commands/delete-range) | +| .deleteSelection() | Delete the selection, if there is one. | [More](/api/commands/delete-selection) | +| .enter() | Trigger enter. | [More](/api/commands/enter) | +| .focus() | Focus the editor at the given position. | [More](/api/commands/focus) | +| .keyboardShortcut() | Trigger a keyboard shortcut. | [More](/api/commands/keyboard-shortcut) | +| .scrollIntoView() | Scroll the selection into view. | [More](/api/commands/scroll-into-view) | +| .selectAll() | Select the whole document. | [More](/api/commands/select-all) | +| .selectNodeBackward() | Select a node backward. | [More](/api/commands/select-node-backward) | +| .selectNodeForward() | Select a node forward. | [More](/api/commands/select-node-forward) | +| .selectParentNode() | Select the parent node. | [More](/api/commands/select-parent-node) |