Merge pull request #49 from toeverything/example-markdown

Markdown updates
This commit is contained in:
Qi
2022-10-24 18:21:16 +08:00
committed by GitHub
2 changed files with 69 additions and 69 deletions

View File

@@ -1,50 +1,50 @@
const exampleMarkdown = `The [AFFiNE Alpha](https://pathfinder.affine.systems/) is here! 👏 const exampleMarkdown = `The AFFiNE Alpha is here! You can also view our [Official Website](https://affine.pro/)!
**What's different in AFFiNE Alpha?** **What's different in AFFiNE Alpha?**
1. A much ~smoother editing~ experience, with much ~greater stability~; 1. A much ~smoother editing~ experience, with much ~greater stability~;
2. More complete ~Markdown~ support and improved ~keyboard shortcuts~; 2. More complete ~Markdown~ support and improved ~keyboard shortcuts~;
3. New features such as ~dark mode~ 3. New features such as ~dark mode~;
* **Switch between view styles using the** ☀ **and** 🌙. * **Switch between view styles using the** ☀ **and** 🌙.
4. ~Clean and modern UI/UX~ design. 4. ~Clean and modern UI/UX~ design.
**Looking for Markdown syntax or keyboard shortcuts?** **Looking for Markdown syntax or keyboard shortcuts?**
* Find the (?) in the bottom right, then the ️, to view a full list. of \`Keyboard Shortcuts\` * Find the (?) in the bottom right, then the ️⌨️, to view a full list of \`Keyboard Shortcuts\`
**Have an enjoyable editing experience !!!** **😃** **Have an enjoyable editing experience !!!** 😃
Have some feedback or just want to get in touch? Use the (?), then 🎧 to get in touch and join our communities. Have some feedback or just want to get in touch? Use the (?), then 🎧 to get in touch and join our communities.
**Still in development** **Still in development**
There also somethings you should consider about this AFFiNE Alpha including some ~limitations~: There are also some things you should consider about this AFFiNE Alpha including some ~limitations~:
* Single page editing - currently editing multiple docs/pages is not supported; * Single page editing - currently editing multiple docs/pages is not supported;
* Changes are not automatically stored, to save changes you should export your data. Options can be found by going to the top right and finding the \`⋮\` icon. * Changes are not automatically stored, to save changes you should export your data. Options can be found by going to the top right and finding the \`⋮\` icon;
* Without an import/open feature you are still able to access your data by copying it back in. * Without an import/open feature you are still able to access your data by copying it back in.
**Keyboard Shortcuts:** **Keyboard Shortcuts:**
1. Undo: \`⌘ + Z\` or \`Ctrl+Z\` 1. Undo: \`⌘+Z\` or \`Ctrl+Z\`
2. Redo: \`⌘ + ⇧ + Z\` or \`Ctrl+Shift+Z\` 2. Redo: \`⌘+⇧+Z\` or \`Ctrl+Shift+Z\`
3. Bold: \`⌘ + B\` or \`Ctrl+B\` 3. Bold: \`⌘+B\` or \`Ctrl+B\`
4. Italic: \`⌘ + I\` or \`Ctrl+I\` 4. Italic: \`⌘+I\` or \`Ctrl+I\`
5. Underline: \`⌘ + U\` or \`Ctrl+U\` 5. Underline: \`⌘+U\` or \`Ctrl+U\`
6. Strikethrough: \`⌘ + ⇧ + S\` or \`Ctrl+Shift+S\` 6. Strikethrough: \`⌘+⇧+S\` or \`Ctrl+Shift+S\`
7. Inline code: \`⌘ + E\` or \`Ctrl+E\` 7. Inline code: \`⌘+E\` or \`Ctrl+E\`
8. Link: \`⌘ + K\` or \`Ctrl+K\` 8. Link: \`⌘+K\` or \`Ctrl+K\`
9. Body text: \`⌘ + ⌥ + 0\` or \`Ctrl+Shift+0\` 9. Body text: \`⌘+⌥+0\` or \`Ctrl+Shift+0\`
10. Heading 1: \`⌘ + ⌥ + 1\` or \`Ctrl+Shift+1\` 10. Heading 1: \`⌘+⌥+1\` or \`Ctrl+Shift+1\`
11. Heading 2: \`⌘ + ⌥ + 2\` or \`Ctrl+Shift+2\` 11. Heading 2: \`⌘+⌥+2\` or \`Ctrl+Shift+2\`
12. Heading 3: \`⌘ + ⌥ + 3\` or \`Ctrl+Shift+3\` 12. Heading 3: \`⌘+⌥+3\` or \`Ctrl+Shift+3\`
13. Heading 4: \`⌘ + ⌥ + 4\` or \`Ctrl+Shift+4\` 13. Heading 4: \`⌘+⌥+4\` or \`Ctrl+Shift+4\`
14. Heading 5: \`⌘ + ⌥ + 5\` or \`Ctrl+Shift+5\` 14. Heading 5: \`⌘+⌥+5\` or \`Ctrl+Shift+5\`
15. Heading 6: \`⌘ + ⌥ + 6\` or \`Ctrl+Shift+6\` 15. Heading 6: \`⌘+⌥+6\` or \`Ctrl+Shift+6\`
16. Increase indent: \`Tab\` 16. Increase indent: \`Tab\`
17. Reduce indent: \`⇧ + Tab\` or \`Shift+Tab\` 17. Reduce indent: \`⇧+Tab\` or \`Shift+Tab\`
_Markdown Syntax:_ **Markdown Syntax:**
1. Bold: \`**text**\` 1. Bold: \`**text**\`
2. Italic: \`*text*\` 2. Italic: \`*text*\`

View File

@@ -1,21 +1,21 @@
export const macKeyboardShortcuts = { export const macKeyboardShortcuts = {
Undo: '⌘ + Z', Undo: '⌘+Z',
Redo: '⌘ + ⇧ + Z', Redo: '⌘+⇧+Z',
Bold: '⌘ + B', Bold: '⌘+B',
Italic: '⌘ + I', Italic: '⌘+I',
Underline: '⌘ + U', Underline: '⌘+U',
Strikethrough: '⌘ + ⇧ + S', Strikethrough: '⌘+⇧+S',
'Inline code': ' ⌘ + E', 'Inline code': ' ⌘+E',
Link: '⌘ + K', Link: '⌘+K',
'Body text': '⌘ + ⌥ + 0', 'Body text': '⌘+⌥+0',
'Heading 1': '⌘ + ⌥ + 1', 'Heading 1': '⌘+⌥+1',
'Heading 2': '⌘ + ⌥ + 2', 'Heading 2': '⌘+⌥+2',
'Heading 3': '⌘ + ⌥ + 3', 'Heading 3': '⌘+⌥+3',
'Heading 4': '⌘ + ⌥ + 4', 'Heading 4': '⌘+⌥+4',
'Heading 5': '⌘ + ⌥ + 5', 'Heading 5': '⌘+⌥+5',
'Heading 6': '⌘ + ⌥ + 6', 'Heading 6': '⌘+⌥+6',
'Increase indent': 'Tab', 'Increase indent': 'Tab',
'Reduce indent': '⇧ + Tab', 'Reduce indent': '⇧+Tab',
}; };
export const macMarkdownShortcuts = { export const macMarkdownShortcuts = {
@@ -23,44 +23,44 @@ export const macMarkdownShortcuts = {
Italic: '*Text* ', Italic: '*Text* ',
Underline: '~Text~ ', Underline: '~Text~ ',
Strikethrough: '~~Text~~ ', Strikethrough: '~~Text~~ ',
'Inline code': '`Code` ', 'Inline code': '`Text` ',
'Heading 1': '# ', 'Heading 1': '# Text',
'Heading 2': '## ', 'Heading 2': '## Text',
'Heading 3': '### ', 'Heading 3': '### Text',
'Heading 4': '#### ', 'Heading 4': '#### Text',
'Heading 5': '##### ', 'Heading 5': '##### Text',
'Heading 6': '###### ', 'Heading 6': '###### Text',
}; };
export const windowsKeyboardShortcuts = { export const windowsKeyboardShortcuts = {
Undo: 'Ctrl + Z', Undo: 'Ctrl+Z',
Redo: 'Ctrl + Y', Redo: 'Ctrl+Y',
Bold: 'Ctrl + B', Bold: 'Ctrl+B',
Italic: 'Ctrl + I', Italic: 'Ctrl+I',
Underline: 'Ctrl + U', Underline: 'Ctrl+U',
Strikethrough: 'Ctrl + Shift + S', Strikethrough: 'Ctrl+Shift+S',
'Inline code': ' Ctrl + E', 'Inline code': ' Ctrl+E',
Link: 'Ctrl + K', Link: 'Ctrl+K',
'Body text': 'Ctrl + Shift + 0', 'Body text': 'Ctrl+Shift+0',
'Heading 1': 'Ctrl + Shift + 1', 'Heading 1': 'Ctrl+Shift+1',
'Heading 2': 'Ctrl + Shift + 2', 'Heading 2': 'Ctrl+Shift+2',
'Heading 3': 'Ctrl + Shift + 3', 'Heading 3': 'Ctrl+Shift+3',
'Heading 4': 'Ctrl + Shift + 4', 'Heading 4': 'Ctrl+Shift+4',
'Heading 5': 'Ctrl + Shift + 5', 'Heading 5': 'Ctrl+Shift+5',
'Heading 6': 'Ctrl + Shift + 6', 'Heading 6': 'Ctrl+Shift+6',
'Increase indent': 'Tab', 'Increase indent': 'Tab',
'Reduce indent': 'Shift + Tab', 'Reduce indent': 'Shift+Tab',
}; };
export const winMarkdownShortcuts = { export const winMarkdownShortcuts = {
Bold: '**Text** ', Bold: '**Text** ',
Italic: '*Text* ', Italic: '*Text* ',
Underline: '~Text~ ', Underline: '~Text~ ',
Strikethrough: '~~Text~~ ', Strikethrough: '~~Text~~ ',
'Inline code': '`Code` ', 'Inline code': '`Text` ',
'Heading 1': '# ', 'Heading 1': '# Text',
'Heading 2': '## ', 'Heading 2': '## Text',
'Heading 3': '### ', 'Heading 3': '### Text',
'Heading 4': '#### ', 'Heading 4': '#### Text',
'Heading 5': '##### ', 'Heading 5': '##### Text',
'Heading 6': '###### ', 'Heading 6': '###### Text',
}; };