tiptap/docs/links.yaml

406 lines
12 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
2021-03-31 03:53:29 +08:00
- title: Interactivity
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: Overview
items:
- title: Introduction
link: /introduction
- title: Installation
link: /installation
items:
# - title: CDN
# link: /installation/cdn
# skip: true
- title: Vanilla JavaScript
link: /installation/vanilla-javascript
skip: true
- title: React
link: /installation/react
skip: true
- title: Next.js
link: /installation/nextjs
skip: true
- title: Vue 3
link: /installation/vue3
skip: true
- title: Vue 2
link: /installation/vue2
skip: true
- title: Nuxt.js
link: /installation/nuxt
skip: true
- title: Svelte
link: /installation/svelte
skip: true
# - title: CodeSandbox
# link: /installation/codesandbox
# skip: true
- title: Alpine.js
link: /installation/alpine
skip: true
- title: PHP
link: /installation/php
skip: true
- title: Upgrade guide
link: /overview/upgrade-guide
- title: Changelog
link: /changelog
- title: About the project
link: /about
type: sponsor
- title: Contributing
link: /overview/contributing
2023-06-25 03:13:28 +08:00
# - title: Support
# link: /support
- title: Jobs
link: /jobs
- title: Tiptap Collab
items:
- title: Cloud
link: /cloud
type: new
- title: Tutorials
link: /tutorials
type: new
items:
- title: Getting Started
link: /tutorials/get-started-with-tiptap-collab
- title: JWT Authentication
link: /tutorials/jwt-authentication
2020-08-11 22:31:03 +08:00
- title: Guide
2020-04-18 23:05:29 +08:00
items:
2021-04-07 05:36:07 +08:00
- title: Configuration
2020-12-03 23:52:54 +08:00
link: /guide/configuration
- title: ProseMirror API
feat(pm): new prosemirror package for dependency resolving * chore:(core): migrate to tsup * chore: migrate blockquote and bold to tsup * chore: migrated bubble-menu and bullet-list to tsup * chore: migrated more packages to tsup * chore: migrate code and character extensions to tsup * chore: update package.json to simplify build for all packages * chore: move all packages to tsup as a build process * chore: change ci build task * feat(pm): add prosemirror meta package * rfix: resolve issues with build paths & export mappings * docs: update documentation to include notes for @tiptap/pm * chore(pm): update tsconfig * chore(packages): update packages * fix(pm): add package export infos & fix dependencies * chore(general): start moving to pm package as deps * chore: move to tiptap pm package internally * fix(demos): fix demos working with new pm package * fix(tables): fix tables package * fix(tables): fix tables package * chore(demos): pinned typescript version * chore: remove unnecessary tsconfig * chore: fix netlify build * fix(demos): fix package resolving for pm packages * fix(tests): fix package resolving for pm packages * fix(tests): fix package resolving for pm packages * chore(tests): fix tests not running correctly after pm package * chore(pm): add files to files array * chore: update build workflow * chore(tests): increase timeout time back to 12s * chore(docs): update docs * chore(docs): update installation guides & pm information to docs * chore(docs): add link to prosemirror docs * fix(vue-3): add missing build step * chore(docs): comment out cdn link * chore(docs): remove semicolons from docs * chore(docs): remove unnecessary installation note * chore(docs): remove unnecessary installation note
2023-02-03 00:37:33 +08:00
link: /guide/prosemirror
2021-04-07 05:36:07 +08:00
- title: Menus
2021-04-03 21:21:30 +08:00
link: /guide/menus
2021-04-07 05:36:07 +08:00
- title: Styling
2020-12-03 22:58:04 +08:00
link: /guide/styling
2021-04-07 05:36:07 +08:00
- title: Output
link: /guide/output
2021-01-21 00:58:53 +08:00
- title: Accessibility
link: /guide/accessibility
- title: Collaborative editing
link: /guide/collaborative-editing
2021-04-07 05:36:07 +08:00
- title: Custom extensions
link: /guide/custom-extensions
2021-03-09 18:55:14 +08:00
- title: Interactive node views
2020-11-30 22:33:20 +08:00
link: /guide/node-views
2021-03-11 05:06:18 +08:00
items:
2021-03-18 05:35:41 +08:00
- title: With JavaScript
link: /guide/node-views/js
- title: With React
link: /guide/node-views/react
- title: With Vue
link: /guide/node-views/vue
2021-03-31 03:53:29 +08:00
- title: A few examples
2021-03-11 05:06:18 +08:00
link: /guide/node-views/examples
- title: Working with TypeScript
link: /guide/typescript
2020-08-11 22:35:23 +08:00
2020-08-11 22:31:03 +08:00
- title: API
items:
2021-04-16 03:48:19 +08:00
- title: Introduction
link: /api/introduction
2020-08-11 22:35:23 +08:00
- title: Editor
link: /api/editor
2021-01-26 06:17:02 +08:00
- title: Commands
link: /api/commands
2021-04-07 05:36:07 +08:00
items:
2021-04-21 17:03:33 +08:00
- title: blur
link: /api/commands/blur
- title: clearContent
link: /api/commands/clear-content
2021-04-21 17:03:33 +08:00
- title: clearNodes
link: /api/commands/clear-nodes
- title: createParagraphNear
link: /api/commands/create-paragraph-near
2021-07-28 17:19:42 +08:00
- title: deleteNode
link: /api/commands/delete-node
2021-04-21 17:03:33 +08:00
- 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
2021-06-05 04:58:34 +08:00
- title: forEach
link: /api/commands/for-each
- title: insertContent
link: /api/commands/insert-content
2021-05-06 01:42:47 +08:00
- title: insertContentAt
link: /api/commands/insert-content-at
2021-04-21 17:03:33 +08:00
- 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
2021-04-07 05:36:07 +08:00
- title: setContent
link: /api/commands/set-content
2021-04-21 17:03:33 +08:00
- title: setMark
link: /api/commands/set-mark
2021-06-02 16:50:10 +08:00
- title: setMeta
link: /api/commands/set-meta
2021-04-21 17:03:33 +08:00
- title: setNode
link: /api/commands/set-node
- title: setNodeSelection
link: /api/commands/set-node-selection
- title: setTextSelection
link: /api/commands/set-text-selection
2021-04-21 17:03:33 +08:00
- 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
2021-05-07 16:51:09 +08:00
- title: updateAttributes
2021-04-08 05:08:24 +08:00
link: /api/commands/update-attributes
2021-04-21 17:03:33 +08:00
- title: wrapInList
link: /api/commands/wrap-in-list
- title: Nodes
link: /api/nodes
2020-08-19 03:39:41 +08:00
items:
- title: Blockquote
link: /api/nodes/blockquote
2020-08-19 03:39:41 +08:00
- title: BulletList
link: /api/nodes/bullet-list
- title: CodeBlock
link: /api/nodes/code-block
2021-04-03 21:21:30 +08:00
- 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
2021-01-18 21:39:26 +08:00
- title: Emoji
link: /api/nodes/emoji
type: pro
2020-09-10 18:13:56 +08:00
- title: HardBreak
link: /api/nodes/hard-break
2020-08-19 03:39:41 +08:00
- title: Heading
link: /api/nodes/heading
2020-08-19 03:39:41 +08:00
- title: HorizontalRule
link: /api/nodes/horizontal-rule
2020-10-27 22:32:55 +08:00
- title: Image
link: /api/nodes/image
2020-08-19 03:39:41 +08:00
- title: ListItem
link: /api/nodes/list-item
2021-01-18 21:39:26 +08:00
- title: Mention
link: /api/nodes/mention
2020-08-19 03:39:41 +08:00
- title: OrderedList
link: /api/nodes/ordered-list
- title: Paragraph
link: /api/nodes/paragraph
2020-12-02 17:53:30 +08:00
- title: Table
link: /api/nodes/table
2020-12-04 00:05:22 +08:00
- title: TableRow
link: /api/nodes/table-row
- title: TableCell
link: /api/nodes/table-cell
2021-01-22 07:16:58 +08:00
- 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
2020-11-06 23:39:30 +08:00
- title: TextStyle
2020-11-06 21:46:59 +08:00
link: /api/marks/text-style
- title: Underline
link: /api/marks/underline
- title: Extensions
link: /api/extensions
items:
2021-03-30 20:07:18 +08:00
- title: BubbleMenu
link: /api/extensions/bubble-menu
2021-01-26 06:40:15 +08:00
- title: CharacterCount
link: /api/extensions/character-count
- title: Collaboration
link: /api/extensions/collaboration
- title: CollaborationCursor
link: /api/extensions/collaboration-cursor
- title: Color
link: /api/extensions/color
- title: Dropcursor
link: /api/extensions/dropcursor
2021-04-01 21:47:00 +08:00
- title: FloatingMenu
link: /api/extensions/floating-menu
- title: Focus
link: /api/extensions/focus
2020-11-06 23:06:36 +08:00
- 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
2023-03-16 00:05:59 +08:00
- title: Mathematics
link: /api/extensions/mathematics
type: new
2021-03-25 05:50:30 +08:00
- title: Placeholder
link: /api/extensions/placeholder
2021-06-23 03:28:20 +08:00
- title: StarterKit
link: /api/extensions/starter-kit
- title: TextAlign
2020-10-23 21:23:40 +08:00
link: /api/extensions/text-align
- title: Typography
link: /api/extensions/typography
2021-10-04 02:53:30 +08:00
- title: UniqueID
2021-08-31 00:01:17 +08:00
link: /api/extensions/unique-id
type: pro
2021-01-20 23:56:25 +08:00
- title: Utilities
2021-09-14 23:19:21 +08:00
link: /utilities
2021-01-26 07:57:47 +08:00
redirect: /api/utilities/html
2021-01-20 23:56:25 +08:00
items:
2021-01-26 07:57:47 +08:00
- title: HTML
link: /api/utilities/html
2021-01-20 23:56:25 +08:00
- title: Suggestion
link: /api/utilities/suggestion
2022-01-28 06:04:05 +08:00
- title: Tiptap for PHP
link: /api/utilities/tiptap-php
type: new
2021-02-26 23:36:08 +08:00
- title: Keyboard shortcuts
2021-01-26 06:17:02 +08:00
link: /api/keyboard-shortcuts
2021-04-16 03:48:19 +08:00
- title: Schema
link: /api/schema
- title: Events
link: /api/events