tiptap/docs/links.yaml

466 lines
15 KiB
YAML
Raw Normal View History

# - title: Documentation
# link: introduction
# - title: Examples
# link: /examples
# redirect: /examples/default
# - title: Community
# link: community
# - title: Sponsor
# link: https://github.com/ueberdosis/sponsor
2020-11-30 18:18:05 +08:00
- title: Examples
2021-09-14 23:19:21 +08:00
link: /examples
2021-01-21 19:35:06 +08:00
redirect: /examples/default
2020-11-30 18:18:05 +08:00
items:
2021-01-21 06:19:33 +08:00
- title: Default text editor
2022-01-17 20:24:38 +08:00
icon: edit-box-line
2021-01-21 19:35:06 +08:00
link: /examples/default
2020-11-30 18:18:05 +08:00
- title: Collaborative editing
2022-01-17 20:24:38 +08:00
icon: team-line
2020-11-30 18:18:05 +08:00
link: /examples/collaborative-editing
- title: Markdown shortcuts
2022-01-17 20:24:38 +08:00
icon: markdown-line
2020-11-30 18:18:05 +08:00
link: /examples/markdown-shortcuts
2021-04-01 22:56:56 +08:00
- title: Menus
2022-01-17 20:24:38 +08:00
icon: menu-line
2021-04-01 22:56:56 +08:00
link: /examples/menus
2021-02-05 00:33:59 +08:00
- title: Tables
2022-01-17 20:24:38 +08:00
icon: table-line
2021-02-05 00:33:59 +08:00
link: /examples/tables
- title: Images
2022-01-17 20:24:38 +08:00
icon: image-line
2021-02-05 00:33:59 +08:00
link: /examples/images
2020-11-30 22:58:05 +08:00
- title: Formatting
2022-01-17 20:24:38 +08:00
icon: indent-increase
2020-11-30 22:58:05 +08:00
link: /examples/formatting
2021-03-31 03:53:29 +08:00
- title: Tasks
2022-01-17 20:24:38 +08:00
icon: checkbox-multiple-line
2021-04-01 04:35:00 +08:00
link: /examples/tasks
2021-03-31 03:53:29 +08:00
- title: Long texts
2022-01-17 20:24:38 +08:00
icon: text-spacing
2020-11-30 22:33:20 +08:00
link: /examples/book
2021-03-31 03:53:29 +08:00
- title: Drawing
2022-01-17 20:24:38 +08:00
icon: pencil-ruler-line
2020-12-06 03:56:12 +08:00
link: /examples/drawing
2021-03-31 03:53:29 +08:00
- title: Mentions
2022-01-17 20:24:38 +08:00
icon: at-line
2021-04-01 04:35:00 +08:00
link: /examples/suggestions
2021-02-05 00:33:59 +08:00
- title: Minimal setup
2022-01-17 20:24:38 +08:00
icon: settings-line
2021-02-05 00:33:59 +08:00
link: /examples/minimal
- title: Force a title
2022-01-17 20:24:38 +08:00
icon: file-settings-line
link: /examples/custom-document
2021-03-31 03:53:29 +08:00
- title: A clever editor
2022-01-17 20:24:38 +08:00
icon: mental-health-line
2021-02-06 05:11:01 +08:00
link: /examples/savvy
- title: React components in node views
2022-01-17 20:24:38 +08:00
icon: cursor-fill
2021-04-01 04:35:00 +08:00
link: /examples/interactivity
2021-04-16 01:33:51 +08:00
- title: Syntax highlighting
2022-01-17 20:24:38 +08:00
icon: code-box-fill
2021-04-16 01:33:51 +08:00
link: /examples/syntax-highlighting
2020-11-30 18:18:05 +08:00
- title: Editor
items:
- title: Introduction
link: /introduction
- title: Getting started
link: /installation
items:
- title: Alpine.js
link: /installation/alpine
skip: true
2023-08-12 01:33:46 +08:00
- title: CDN
link: /installation/cdn
skip: true
- title: Next.js
link: /installation/nextjs
skip: true
- title: Nuxt.js
link: /installation/nuxt
skip: true
- title: PHP
link: /installation/php
skip: true
2024-01-24 16:18:37 +08:00
- title: React
link: /installation/react
skip: true
- title: Svelte
link: /installation/svelte
skip: true
- title: Vanilla JavaScript
link: /installation/vanilla-javascript
skip: true
- title: Vue 3
link: /installation/vue3
skip: true
- title: Vue 2
link: /installation/vue2
skip: true
2024-01-24 16:18:37 +08:00
- title: API
link: /api
2021-01-20 23:56:25 +08:00
items:
2024-01-24 16:18:37 +08:00
- title: Editor
link: /api/editor
- title: Node Positions
link: /api/nodepos
- title: Commands
link: /api/commands
items:
- title: blur
link: /api/commands/blur
- title: clearContent
link: /api/commands/clear-content
- title: clearNodes
link: /api/commands/clear-nodes
- title: createParagraphNear
link: /api/commands/create-paragraph-near
- title: deleteNode
link: /api/commands/delete-node
- title: deleteRange
link: /api/commands/delete-range
- title: deleteSelection
link: /api/commands/delete-selection
- title: enter
link: /api/commands/enter
- title: exitCode
link: /api/commands/exit-code
- title: extendMarkRange
link: /api/commands/extend-mark-range
- title: focus
link: /api/commands/focus
- title: forEach
link: /api/commands/for-each
- title: insertContent
link: /api/commands/insert-content
- title: insertContentAt
link: /api/commands/insert-content-at
- title: joinBackward
link: /api/commands/join-backward
- title: joinForward
link: /api/commands/join-forward
- title: keyboardShortcut
link: /api/commands/keyboard-shortcut
- title: liftEmptyBlock
link: /api/commands/lift-empty-block
- title: liftListItem
link: /api/commands/lift-list-item
- title: lift
link: /api/commands/lift
- title: newlineInCode
link: /api/commands/newline-in-code
- title: resetAttributes
link: /api/commands/reset-attributes
- title: scrollIntoView
link: /api/commands/scroll-into-view
- title: selectAll
link: /api/commands/select-all
- title: selectNodeBackward
link: /api/commands/select-node-backward
- title: selectNodeForward
link: /api/commands/select-node-forward
- title: selectParentNode
link: /api/commands/select-parent-node
- title: selectTextblockEnd
link: /api/commands/select-textblock-end
- title: selectTextblockStart
link: /api/commands/select-textblock-start
- title: setContent
link: /api/commands/set-content
- title: setMark
link: /api/commands/set-mark
- title: setMeta
link: /api/commands/set-meta
- title: setNode
link: /api/commands/set-node
- title: setNodeSelection
link: /api/commands/set-node-selection
- title: setTextSelection
link: /api/commands/set-text-selection
- title: sinkListItem
link: /api/commands/sink-list-item
- title: splitBlock
link: /api/commands/split-block
- title: splitListItem
link: /api/commands/split-list-item
- title: toggleList
link: /api/commands/toggle-list
- title: toggleMark
link: /api/commands/toggle-mark
- title: toggleNode
link: /api/commands/toggle-node
- title: toggleWrap
link: /api/commands/toggle-wrap
- title: undoInputRule
link: /api/commands/undo-input-rule
- title: unsetAllMarks
link: /api/commands/unset-all-marks
- title: unsetMark
link: /api/commands/unset-mark
- title: updateAttributes
link: /api/commands/update-attributes
- title: wrapInList
link: /api/commands/wrap-in-list
- title: Nodes
link: /api/nodes
items:
- title: Blockquote
link: /api/nodes/blockquote
- title: BulletList
link: /api/nodes/bullet-list
- title: CodeBlock
link: /api/nodes/code-block
- title: CodeBlockLowlight
link: /api/nodes/code-block-lowlight
- title: Document
link: /api/nodes/document
- title: Details
link: /api/nodes/details
type: pro
- title: DetailsSummary
link: /api/nodes/details-summary
type: pro
- title: DetailsContent
link: /api/nodes/details-content
type: pro
- title: Emoji
link: /api/nodes/emoji
type: pro
- title: HardBreak
link: /api/nodes/hard-break
- title: Heading
link: /api/nodes/heading
- title: HorizontalRule
link: /api/nodes/horizontal-rule
- title: Image
link: /api/nodes/image
- title: ListItem
link: /api/nodes/list-item
- title: Mention
link: /api/nodes/mention
- title: OrderedList
link: /api/nodes/ordered-list
- title: Paragraph
link: /api/nodes/paragraph
- title: Table
link: /api/nodes/table
- title: TableRow
link: /api/nodes/table-row
- title: TableCell
link: /api/nodes/table-cell
- title: TableHeader
link: /api/nodes/table-header
- title: TaskList
link: /api/nodes/task-list
- title: TaskItem
link: /api/nodes/task-item
- title: Text
link: /api/nodes/text
- title: YouTube
link: /api/nodes/youtube
- title: Marks
link: /api/marks
items:
- title: Bold
link: /api/marks/bold
- title: Code
link: /api/marks/code
- title: Highlight
link: /api/marks/highlight
- title: Italic
link: /api/marks/italic
- title: Link
link: /api/marks/link
- title: Strike
link: /api/marks/strike
- title: Subscript
link: /api/marks/subscript
- title: Superscript
link: /api/marks/superscript
- title: TextStyle
link: /api/marks/text-style
- title: Underline
link: /api/marks/underline
- title: Extensions
link: /api/extensions
items:
- title: AI
link: /ai/introduction
- title: BubbleMenu
link: /api/extensions/bubble-menu
- title: CharacterCount
link: /api/extensions/character-count
2024-02-15 23:01:49 +08:00
- title: Comments
2024-02-15 23:24:48 +08:00
link: /api/extensions/comments
2024-02-15 23:01:49 +08:00
type: beta
2024-01-24 16:18:37 +08:00
- title: Collaboration
link: /api/extensions/collaboration
- title: CollaborationCursor
link: /api/extensions/collaboration-cursor
- title: CollaborationHistory
link: /api/extensions/collaboration-history
type: new
- title: Color
link: /api/extensions/color
- title: Dropcursor
link: /api/extensions/dropcursor
- title: FileHandler
link: /api/extensions/file-handler
type: new
- title: FloatingMenu
link: /api/extensions/floating-menu
- title: Focus
link: /api/extensions/focus
- title: FontFamily
link: /api/extensions/font-family
- title: Gapcursor
link: /api/extensions/gapcursor
- title: History
link: /api/extensions/history
- title: InvisibleCharacters
link: /api/extensions/invisible-characters
type: new
- title: Mathematics
link: /api/extensions/mathematics
type: new
- title: Placeholder
link: /api/extensions/placeholder
- title: StarterKit
link: /api/extensions/starter-kit
- title: TextAlign
link: /api/extensions/text-align
- title: Typography
link: /api/extensions/typography
- title: UniqueID
link: /api/extensions/unique-id
type: pro
- title: Utilities
2024-03-12 16:58:49 +08:00
link: /api/utilities/html
2024-01-24 16:18:37 +08:00
items:
- title: HTML
link: /api/utilities/html
- title: Suggestion
link: /api/utilities/suggestion
- title: Tiptap for PHP
link: /api/utilities/tiptap-php
- title: Keyboard shortcuts
link: /api/keyboard-shortcuts
- title: Schema
link: /api/schema
- title: Events
link: /api/events
- title: Guides
link: /guide
items:
2024-01-24 16:18:37 +08:00
- title: Configuration
link: /guide/configuration
- title: ProseMirror API
link: /guide/prosemirror
- title: Menus
link: /guide/menus
- title: Styling
link: /guide/styling
- title: Output
link: /guide/output
- title: Accessibility
link: /guide/accessibility
- title: Collaborative editing
link: /guide/collaborative-editing
- title: Custom extensions
link: /guide/custom-extensions
- title: Interactive node views
link: /guide/node-views
items:
- title: With JavaScript
link: /guide/node-views/js
- title: With React
link: /guide/node-views/react
- title: With Vue
link: /guide/node-views/vue
- title: A few examples
link: /guide/node-views/examples
- title: Working with TypeScript
link: /guide/typescript
- title: Upgrade Editor to v2
link: /overview/upgrade-guide
2024-02-15 22:53:03 +08:00
- title: Comments
2024-02-16 18:21:25 +08:00
type: beta
2024-02-15 22:53:03 +08:00
items:
2024-03-12 20:17:07 +08:00
- title: Overview
link: /comments/overview
2024-02-15 22:53:03 +08:00
- title: Getting started
link: /comments/getting-started
- title: Managing threads
link: /comments/managing-threads
- title: Styling threads
link: /comments/styling-threads
2024-03-06 19:38:26 +08:00
- title: Editor API
2024-02-15 22:53:03 +08:00
link: /comments/api
2024-03-06 19:38:26 +08:00
- title: REST API
link: /comments/rest-api
- title: Webhook
link: /comments/webhook
2024-02-15 22:53:03 +08:00
- title: Configuration
link: /comments/configuration
- title: Collaboration
items:
2024-03-12 00:54:06 +08:00
- title: Overview
link: /collaboration/overview
- title: Install
link: /collaboration/install
2024-03-09 16:47:16 +08:00
- title: Authenticate
link: /collaboration/authenticate
2024-03-11 22:36:51 +08:00
- title: Provider
link: /collaboration/provider
2024-03-11 22:42:27 +08:00
- title: Events
link: /collaboration/events
2024-03-13 02:00:15 +08:00
- title: Awareness
link: /collaboration/awareness
2024-01-24 16:18:37 +08:00
- title: Management API
link: /collaboration/management-api
2024-02-20 15:59:20 +08:00
- title: Document Manipulation
2024-02-20 15:51:46 +08:00
link: /collaboration/backend-document-manipulation
type: beta
2024-01-24 16:18:37 +08:00
- title: Webhook
link: /collaboration/webhook
- title: Guides
2024-01-24 16:18:37 +08:00
link: /collaboration/guides
items:
2024-03-13 15:58:52 +08:00
- title: JWT Authentication
link: /collaboration/guides/jwt-authentication
2024-03-13 15:39:15 +08:00
- title: Naming documents
link: /collaboration/guides/naming-documents
2024-03-13 15:58:52 +08:00
- title: Offline support
link: /collaboration/guides/offline-support
- title: Simple collaboration app
2024-01-24 16:18:37 +08:00
link: /collaboration/guides/simple-collaboration-app
- title: Content AI
items:
- title: Introduction
link: /ai/introduction
- title: Getting started
link: /ai/setup
- title: Extension
link: /ai/extension
- title: Commands
link: /ai/extension/commands
type: new
- title: Custom LLM
link: /ai/advanced-usage/custom-llm
type: new
- title: Other Resources
items:
- title: About the project
link: /about
type: sponsor
- title: Editor changelog
link: /changelog
- title: Contributing
link: /overview/contributing