diff --git a/docs/src/docPages/general/roadmap.md b/docs/src/docPages/general/roadmap.md deleted file mode 100644 index 3b0fa3ba..00000000 --- a/docs/src/docPages/general/roadmap.md +++ /dev/null @@ -1,80 +0,0 @@ -# Roadmap - -## Tasks - -1. Refactoring the API & Extension Manager -2. Improve testing: Add editor instance to the DOM element -3. Building the first batch of basic extensions (bold, italic), writing tests -4. Building more complex examples from the extensions - -## New features - -* generate schema without initializing tiptap, to make SSR easier (e. g. `getSchema([new Doc(), new Paragraph()])`) - -## Requested features - -* Basic Styling - * https://github.com/ueberdosis/tiptap/issues/507 -* Support vor Vue.js 3 -* Easily add custom classes to everything - * https://github.com/ueberdosis/tiptap/discussions/817 -* Text snippets - * https://github.com/ueberdosis/tiptap/issues/737 -* Markdown Support - -## Requested extensions - -* Alignment - * https://github.com/ueberdosis/tiptap/pull/544 -* Font color -* Font family -* Font size -* Created embed from pasted YouTube URL -* Superscript/Subscript - * https://github.com/ueberdosis/tiptap/discussions/813 -* Math Support - * https://github.com/ueberdosis/tiptap/issues/179 - * https://github.com/ueberdosis/tiptap/issues/698 -* Resizeable Images - * https://gist.github.com/zachjharris/a5442efbdff11948d085b6b1406dfbe6 - -## Ideas - -* A `@tiptap/extensions` package would be helpful to make imports easier. -* Add more shorcuts: - * Ctrl+I → Italic ✅ - * Ctrl+B → Bold ✅ - * Ctrl+K → Link (Medium, Tumblr, Slack, Google Docs, Word) - * Ctrl+Shift+K → Code (Slack) - * Shift+Enter → Line break - * Ctrl+Shift+X → Strikethrough (Slack) - * Alt+Shift+5 → Strikethrough (Google Docs) - * Ctrl+Shift+6 → Strikethrough (Tumblr) - * Ctrl+Alt+0 → Paragraph (Google Docs) - * Ctrl+Alt+1 to 6 → Heading (Google Docs, Word, ~Medium, ~Slack) - * Ctrl+Shift+2 → Heading (Tumblr) - * Ctrl+Shift+7 → Ordered list (Google Docs, Slack, Tumblr) - * Ctrl+Shift+8 → Unordered list (Google Docs, Slack, Tumblr) - * Tab, Shift+Tab → Increase / decrease nesting in lists - * Ctrl+], Ctrl+[ → Same as above (when Tab needs to be used) - * Ctrl+Shift+9 → Blockquote (Tumblr) - * Ctrl+Alt+K → Code block (Slack) - * Ctrl+R → Horizontal ruler (Stack Overflow) -* Markdown shortcuts - * #+Space → Heading (the number of # determines the header level) - * *+Space, -+Space → Unordered list - * 1.+Space → Ordered list - * >+Space → Blockquote - * ```+Space → Code block - * ---- → Horizontal ruler - * ![] → Embedded resource (not part of Slack, but would it not be fancy?) - * :emoji: → Emoji (based on the name). A nice-to-have, most certainly. -* General shortcuts - * Ctrl+C, Ctrl+X, Ctrl+V: copy, cut, paste - * Ctrl+Z, Ctrl+Shift+Z, Ctrl+Y: undo, redo - * Ctrl+Backspace: delete previous word - * Ctrl+Delete: delete next word - * Ctrl+Home, Ctrl+End: go to the start / end of the whole document - * Ctrl+F, Ctrl+G: find, find next occurrence - * Ctrl+S: if there is no auto-saving, this should save the document - * Ctrl+/: show shortcuts (Medium, Slack) diff --git a/docs/src/docPages/general/upgrade-guide.md b/docs/src/docPages/general/upgrade-guide.md deleted file mode 100644 index 8c8e6d1f..00000000 --- a/docs/src/docPages/general/upgrade-guide.md +++ /dev/null @@ -1,3 +0,0 @@ -# Upgrade Guide - -## Upgrading from 1.x to 2.x \ No newline at end of file diff --git a/docs/src/docPages/general/installation.md b/docs/src/docPages/overview/installation.md similarity index 97% rename from docs/src/docPages/general/installation.md rename to docs/src/docPages/overview/installation.md index 02e4a661..7d792f68 100644 --- a/docs/src/docPages/general/installation.md +++ b/docs/src/docPages/overview/installation.md @@ -10,7 +10,7 @@ Use tiptap with vanilla JavaScript for a very lightweight and raw experience. If # With npm npm install @tiptap/core @tiptap/starter-kit -# With yarn +# Or: With Yarn yarn add @tiptap/core @tiptap/starter-kit ``` @@ -32,10 +32,10 @@ new Editor({ To use tiptap with Vue.js (and tools that are based on Vue.js) install the Vue.js adapter in your project: ```bash -# Using npm +# With npm npm install @tiptap/vue @tiptap/vue-starter-kit -# Using Yarn +# Or: With Yarn yarn add @tiptap/vue @tiptap/vue-starter-kit ``` diff --git a/docs/src/docPages/overview/roadmap.md b/docs/src/docPages/overview/roadmap.md new file mode 100644 index 00000000..55bfc8ce --- /dev/null +++ b/docs/src/docPages/overview/roadmap.md @@ -0,0 +1,3 @@ +# Roadmap + +See https://github.com/ueberdosis/tiptap-next/projects/1 diff --git a/docs/src/docPages/overview/upgrade-guide.md b/docs/src/docPages/overview/upgrade-guide.md new file mode 100644 index 00000000..1962276d --- /dev/null +++ b/docs/src/docPages/overview/upgrade-guide.md @@ -0,0 +1,6 @@ +# Upgrade Guide + +- reasons to upgrade to tiptap 2 +- link to roadmap + +## Upgrading from 1.x to 2.x \ No newline at end of file diff --git a/docs/src/links.yaml b/docs/src/links.yaml index fa844aae..5cf3d4aa 100644 --- a/docs/src/links.yaml +++ b/docs/src/links.yaml @@ -1,14 +1,14 @@ -- title: General +- title: Overview items: - title: Introduction link: / - title: Installation - link: /general/installation + link: /overview/installation - title: Upgrade Guide - link: /general/upgrade-guide + link: /overview/upgrade-guide draft: true - title: Roadmap - link: /general/roadmap + link: /overview/roadmap draft: true - title: Guide