Fix issues with non-US keyboards and add key binding settings page (m…

…arktext#2930) Replaced the key manager by atom-keymap to support non-US keyboards and dead key translation on macOS and Windows. In addition, a GUI for key bindings was added.
kehei · Jan 29, 2022 · 6b3ead9 · 6b3ead9
1 parent c959d18
commit 6b3ead9
Show file tree

Hide file tree

Showing 41 changed files with 2,076 additions and 1,231 deletions.
diff --git a/docs/CLI.md b/docs/CLI.md
@@ -7,7 +7,6 @@ Usage: marktext [commands] [path ...]
 
         --debug                   Enable debug mode
         --safe                    Disable plugins and other user configuration
-        --dump-keyboard-layout    Dump keyboard information
     -n, --new-window              Open a new window on second-instance
         --user-data-dir           Change the user data directory
         --disable-gpu             Disable GPU hardware acceleration

diff --git a/docs/KEYBINDINGS.md b/docs/KEYBINDINGS.md
@@ -17,12 +17,13 @@ Here is an example:
 - `Option` on macOS
 - `Ctrl`
 - `Shift`
-- `Alt` and `AltGr` on Linux and Windows
-- `Super` on Linux and Windows
+- `Alt` (equal to `Option` on macOS)
+
+Please don't bind `AltGr`, use `Cltr+Alt` instead.
 
 ## Available keys
 
-- `0-9`, `A-Z`, `F1-F24` and punctuations
+- `0-9`, `A-Z`, `F1-F24` and punctuations like `/` or `#`
 - `Plus`, `Space`, `Tab`, `Backspace`, `Delete`, `Insert`, `Return/Enter`, `Esc`, `Home`, `End` and `PrintScreen`
 - `Up`, `Down`, `Left` and `Right`
 - `PageUp` and `PageDown`

diff --git a/docs/KEYBINDINGS_LINUX.md b/docs/KEYBINDINGS_LINUX.md
@@ -62,11 +62,11 @@ MarkText key bindings for Linux. Please see [general key bindings](KEYBINDINGS.m
 | `paragraph.math-formula`    | <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>M</kbd>   | Insert a math block                      |
 | `paragraph.html-block`      | <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>H</kbd>   | Insert a HTML block                      |
 | `paragraph.order-list`      | <kbd>Ctrl</kbd>+<kbd>G</kbd>                  | Insert a ordered list                    |
-| `paragraph.bullet-list`     | <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>G</kbd> | Insert a unordered list                  |
+| `paragraph.bullet-list`     | <kbd>Ctrl</kbd>+<kbd>H</kbd>                  | Insert a unordered list                  |
 | `paragraph.task-list`       | <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>X</kbd> | Insert a task list                       |
 | `paragraph.loose-list-item` | <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>L</kbd> | Convert a list item to a loose list item |
 | `paragraph.paragraph`       | <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>0</kbd> | Convert a heading to a paragraph         |
-| `paragraph.horizontal-line` | <kbd>Ctrl</kbd>+<kbd>H</kbd>                  | Add a horizontal line                    |
+| `paragraph.horizontal-line` | <kbd>Ctrl</kbd>+<kbd>\_</kbd>                 | Add a horizontal line                    |
 | `paragraph.front-matter`    | <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Y</kbd> | Insert a YAML frontmatter block          |
 
 #### Format menu
@@ -79,7 +79,7 @@ MarkText key bindings for Linux. Please see [general key bindings](KEYBINDINGS.m
 | `format.superscript`  | -                                             | Change the selected text to underline           |
 | `format.subscript`    | -                                             | Change the selected text to underline           |
 | `format.highlight`    | <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>H</kbd> | Highlight the selected text by <mark>tag</mark> |
-| `format.inline-code`  | <kbd>Ctrl</kbd>+<kbd>`</kbd>                  | Change the selected text to inline code         |
+| `format.inline-code`  | <kbd>Ctrl</kbd>+<kbd>Y</kbd>                  | Change the selected text to inline code         |
 | `format.inline-math`  | <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>M</kbd> | Change the selected text to inline math         |
 | `format.strike`       | <kbd>Ctrl</kbd>+<kbd>D</kbd>                  | Strike through the selected text                |
 | `format.hyperlink`    | <kbd>Ctrl</kbd>+<kbd>L</kbd>                  | Insert a hyperlink                              |
@@ -136,4 +136,4 @@ MarkText key bindings for Linux. Please see [general key bindings](KEYBINDINGS.m
 
 | Id                | Default                      | Description            |
 | ----------------- | ---------------------------- | ---------------------- |
-| `file.quick-open` | <kbd>Ctrl</kbd>+<kbd>P</kbd> | Open quick open dialog |
+| `file.quick-open` | <kbd>Ctrl</kbd>+<kbd>P</kbd> | Show quick open dialog |
diff --git a/docs/KEYBINDINGS_OSX.md b/docs/KEYBINDINGS_OSX.md
@@ -6,12 +6,12 @@ MarkText key bindings for macOS. Please see [general key bindings](KEYBINDINGS.m
 
 #### MarkText menu
 
-| Id                 | Default                                        | Description                            |
-| ------------------ | ---------------------------------------------- | -------------------------------------- |
-| `mt.hide`          | <kbd>Command</kbd>+<kbd>H</kbd>                | Hide MarkText                          |
-| `mt.hide-others`   | <kbd>Command</kbd>+<kbd>Alt</kbd>+<kbd>H</kbd> | Hide all other windows except MarkText |
-| `file.preferences` | <kbd>Command</kbd>+<kbd>,</kbd>                | Open settings window                   |
-| `file.quit`        | <kbd>Command</kbd>+<kbd>Q</kbd>                | Quit MarkText                          |
+| Id                 | Default                                           | Description                            |
+| ------------------ | ------------------------------------------------- | -------------------------------------- |
+| `mt.hide`          | <kbd>Command</kbd>+<kbd>H</kbd>                   | Hide MarkText                          |
+| `mt.hide-others`   | <kbd>Command</kbd>+<kbd>Option</kbd>+<kbd>H</kbd> | Hide all other windows except MarkText |
+| `file.preferences` | <kbd>Command</kbd>+<kbd>,</kbd>                   | Open settings window                   |
+| `file.quit`        | <kbd>Command</kbd>+<kbd>Q</kbd>                   | Quit MarkText                          |
 
 #### File menu
 
@@ -31,51 +31,51 @@ MarkText key bindings for macOS. Please see [general key bindings](KEYBINDINGS.m
 
 #### Edit menu
 
-| Id                       | Default                                          | Description                                     |
-|:------------------------ | ------------------------------------------------ | ----------------------------------------------- |
-| `edit.undo`              | <kbd>Command</kbd>+<kbd>Z</kbd>                  | Undo last operation                             |
-| `edit.redo`              | <kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>Z</kbd> | Redo last operation                             |
-| `edit.cut`               | <kbd>Command</kbd>+<kbd>X</kbd>                  | Cut selected text                               |
-| `edit.copy`              | <kbd>Command</kbd>+<kbd>C</kbd>                  | Copy selected text                              |
-| `edit.paste`             | <kbd>Command</kbd>+<kbd>V</kbd>                  | Paste text                                      |
-| `edit.copy-as-markdown`  | <kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>C</kbd> | Copy selected text as markdown                  |
-| `edit.copy-as-html`      | -                                                | Copy selected text as html                      |
-| `edit.paste-as-plaintext` | <kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>V</kbd> | Copy selected text as plaintext                 |
-| `edit.select-all`        | <kbd>Command</kbd>+<kbd>A</kbd>                  | Select all text of the document                 |
-| `edit.duplicate`         | <kbd>Command</kbd>+<kbd>Alt</kbd>+<kbd>P</kbd>   | Duplicate the current paragraph                 |
-| `edit.create-paragraph`  | <kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>N</kbd> | Create a new paragraph after the current one    |
-| `edit.delete-paragraph`  | <kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>D</kbd> | Delete current paragraph                        |
-| `edit.find`              | <kbd>Command</kbd>+<kbd>F</kbd>                  | Find information in the document                |
-| `edit.find-next`         | <kbd>Cmd</kbd>+<kbd>G</kbd>                      | Continue the search and find the next match     |
-| `edit.find-previous`     | <kbd>Shift</kbd>+<kbd>Cmd</kbd>+<kbd>G</kbd>     | Continue the search and find the previous match |
-| `edit.replace`           | <kbd>Command</kbd>+<kbd>Alt</kbd>+<kbd>F</kbd>   | Replace the information with a replacement      |
-| `edit.find-in-folder`    | <kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>F</kbd> | Find files contain the keyword in opend folder  |
-| `edit.screenshot`        | <kbd>Command</kbd>+<kbd>Alt</kbd>+<kbd>A</kbd>   | Get the screenshot                              |
+| Id                        | Default                                           | Description                                     |
+|:------------------------- | ------------------------------------------------- | ----------------------------------------------- |
+| `edit.undo`               | <kbd>Command</kbd>+<kbd>Z</kbd>                   | Undo last operation                             |
+| `edit.redo`               | <kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>Z</kbd>  | Redo last operation                             |
+| `edit.cut`                | <kbd>Command</kbd>+<kbd>X</kbd>                   | Cut selected text                               |
+| `edit.copy`               | <kbd>Command</kbd>+<kbd>C</kbd>                   | Copy selected text                              |
+| `edit.paste`              | <kbd>Command</kbd>+<kbd>V</kbd>                   | Paste text                                      |
+| `edit.copy-as-markdown`   | <kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>C</kbd>  | Copy selected text as markdown                  |
+| `edit.copy-as-html`       | -                                                 | Copy selected text as html                      |
+| `edit.paste-as-plaintext` | <kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>V</kbd>  | Copy selected text as plaintext                 |
+| `edit.select-all`         | <kbd>Command</kbd>+<kbd>A</kbd>                   | Select all text of the document                 |
+| `edit.duplicate`          | <kbd>Command</kbd>+<kbd>Option</kbd>+<kbd>P</kbd> | Duplicate the current paragraph                 |
+| `edit.create-paragraph`   | <kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>N</kbd>  | Create a new paragraph after the current one    |
+| `edit.delete-paragraph`   | <kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>D</kbd>  | Delete current paragraph                        |
+| `edit.find`               | <kbd>Command</kbd>+<kbd>F</kbd>                   | Find information in the document                |
+| `edit.find-next`          | <kbd>Cmd</kbd>+<kbd>G</kbd>                       | Continue the search and find the next match     |
+| `edit.find-previous`      | <kbd>Shift</kbd>+<kbd>Cmd</kbd>+<kbd>G</kbd>      | Continue the search and find the previous match |
+| `edit.replace`            | <kbd>Command</kbd>+<kbd>Option</kbd>+<kbd>F</kbd> | Replace the information with a replacement      |
+| `edit.find-in-folder`     | <kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>F</kbd>  | Find files contain the keyword in opend folder  |
+| `edit.screenshot`         | <kbd>Command</kbd>+<kbd>Option</kbd>+<kbd>A</kbd> | Get the screenshot                              |
 
 #### Paragraph menu
 
-| Id                          | Default                                          | Description                              |
-| --------------------------- | ------------------------------------------------ | ---------------------------------------- |
-| `paragraph.heading-1`       | <kbd>Command</kbd>+<kbd>1</kbd>                  | Set line as heading 1                    |
-| `paragraph.heading-2`       | <kbd>Command</kbd>+<kbd>2</kbd>                  | Set line as heading 2                    |
-| `paragraph.heading-3`       | <kbd>Command</kbd>+<kbd>3</kbd>                  | Set line as heading 3                    |
-| `paragraph.heading-4`       | <kbd>Command</kbd>+<kbd>4</kbd>                  | Set line as heading 4                    |
-| `paragraph.heading-5`       | <kbd>Command</kbd>+<kbd>5</kbd>                  | Set line as heading 5                    |
-| `paragraph.heading-6`       | <kbd>Command</kbd>+<kbd>6</kbd>                  | Set line as heading 6                    |
-| `paragraph.upgrade-heading` | <kbd>Command</kbd>+<kbd>=</kbd>                  | Upgrade a heading                        |
-| `paragraph.degrade-heading` | <kbd>Command</kbd>+<kbd>-</kbd>                  | Degrade a heading                        |
-| `paragraph.table`           | <kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>T</kbd> | Insert a table                           |
-| `paragraph.code-fence`      | <kbd>Command</kbd>+<kbd>Alt</kbd>+<kbd>C</kbd>   | Insert a code block                      |
-| `paragraph.quote-block`     | <kbd>Command</kbd>+<kbd>Alt</kbd>+<kbd>Q</kbd>   | Insert a quote block                     |
-| `paragraph.math-formula`    | <kbd>Command</kbd>+<kbd>Alt</kbd>+<kbd>M</kbd>   | Insert a math block                      |
-| `paragraph.html-block`      | <kbd>Command</kbd>+<kbd>Alt</kbd>+<kbd>J</kbd>   | Insert a HTML block                      |
-| `paragraph.order-list`      | <kbd>Command</kbd>+<kbd>Alt</kbd>+<kbd>O</kbd>   | Insert a ordered list                    |
-| `paragraph.bullet-list`     | <kbd>Command</kbd>+<kbd>Alt</kbd>+<kbd>U</kbd>   | Insert a unordered list                  |
-| `paragraph.task-list`       | <kbd>Command</kbd>+<kbd>Alt</kbd>+<kbd>X</kbd>   | Insert a task list                       |
-| `paragraph.loose-list-item` | <kbd>Command</kbd>+<kbd>Alt</kbd>+<kbd>L</kbd>   | Convert a list item to a loose list item |
-| `paragraph.paragraph`       | <kbd>Command</kbd>+<kbd>0</kbd>                  | Convert a heading to a paragraph         |
-| `paragraph.horizontal-line` | <kbd>Command</kbd>+<kbd>Alt</kbd>+<kbd>-</kbd>   | Add a horizontal line                    |
-| `paragraph.front-matter`    | <kbd>Command</kbd>+<kbd>Alt</kbd>+<kbd>Y</kbd>   | Insert a YAML frontmatter block          |
+| Id                          | Default                                           | Description                              |
+| --------------------------- | ------------------------------------------------- | ---------------------------------------- |
+| `paragraph.heading-1`       | <kbd>Command</kbd>+<kbd>1</kbd>                   | Set line as heading 1                    |
+| `paragraph.heading-2`       | <kbd>Command</kbd>+<kbd>2</kbd>                   | Set line as heading 2                    |
+| `paragraph.heading-3`       | <kbd>Command</kbd>+<kbd>3</kbd>                   | Set line as heading 3                    |
+| `paragraph.heading-4`       | <kbd>Command</kbd>+<kbd>4</kbd>                   | Set line as heading 4                    |
+| `paragraph.heading-5`       | <kbd>Command</kbd>+<kbd>5</kbd>                   | Set line as heading 5                    |
+| `paragraph.heading-6`       | <kbd>Command</kbd>+<kbd>6</kbd>                   | Set line as heading 6                    |
+| `paragraph.upgrade-heading` | <kbd>Command</kbd>+<kbd>=</kbd>                   | Upgrade a heading                        |
+| `paragraph.degrade-heading` | <kbd>Command</kbd>+<kbd>-</kbd>                   | Degrade a heading                        |
+| `paragraph.table`           | <kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>T</kbd>  | Insert a table                           |
+| `paragraph.code-fence`      | <kbd>Command</kbd>+<kbd>Option</kbd>+<kbd>C</kbd> | Insert a code block                      |
+| `paragraph.quote-block`     | <kbd>Command</kbd>+<kbd>Option</kbd>+<kbd>Q</kbd> | Insert a quote block                     |
+| `paragraph.math-formula`    | <kbd>Command</kbd>+<kbd>Option</kbd>+<kbd>M</kbd> | Insert a math block                      |
+| `paragraph.html-block`      | <kbd>Command</kbd>+<kbd>Option</kbd>+<kbd>J</kbd> | Insert a HTML block                      |
+| `paragraph.order-list`      | <kbd>Command</kbd>+<kbd>Option</kbd>+<kbd>O</kbd> | Insert a ordered list                    |
+| `paragraph.bullet-list`     | <kbd>Command</kbd>+<kbd>Option</kbd>+<kbd>U</kbd> | Insert a unordered list                  |
+| `paragraph.task-list`       | <kbd>Command</kbd>+<kbd>Option</kbd>+<kbd>X</kbd> | Insert a task list                       |
+| `paragraph.loose-list-item` | <kbd>Command</kbd>+<kbd>Option</kbd>+<kbd>L</kbd> | Convert a list item to a loose list item |
+| `paragraph.paragraph`       | <kbd>Command</kbd>+<kbd>0</kbd>                   | Convert a heading to a paragraph         |
+| `paragraph.horizontal-line` | <kbd>Command</kbd>+<kbd>Option</kbd>+<kbd>-</kbd> | Add a horizontal line                    |
+| `paragraph.front-matter`    | <kbd>Command</kbd>+<kbd>Option</kbd>+<kbd>Y</kbd> | Insert a YAML frontmatter block          |
 
 #### Format menu
 
@@ -106,18 +106,18 @@ MarkText key bindings for macOS. Please see [general key bindings](KEYBINDINGS.m
 
 #### View menu
 
-| Id                      | Default                                          | Description                              |
-| ----------------------- | ------------------------------------------------ | ---------------------------------------- |
-| `view.command-palette`  | <kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> | Toggle command palette                   |
-| `view.source-code-mode` | <kbd>Command</kbd>+<kbd>Alt</kbd>+<kbd>S</kbd>   | Switch to source code mode               |
-| `view.typewriter-mode`  | <kbd>Command</kbd>+<kbd>Alt</kbd>+<kbd>T</kbd>   | Enable typewriter mode                   |
-| `view.focus-mode`       | <kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>J</kbd> | Enable focus mode                        |
-| `view.toggle-sidebar`   | <kbd>Command</kbd>+<kbd>J</kbd>                  | Toggle sidebar                           |
-| `view.toggle-tabbar`    | <kbd>Command</kbd>+<kbd>Alt</kbd>+<kbd>B</kbd>   | Toggle tabbar                            |
-| `view.toggle-toc` .     | <kbd>Command</kbd>+<kbd>K</kbd>                  | Toggle table of contents                 |
-| `view.toggle-dev-tools` | <kbd>Command</kbd>+<kbd>Alt</kbd>+<kbd>I</kbd>   | Toggle developer tools (debug mode only) |
-| `view.dev-reload`       | <kbd>Command</kbd>+<kbd>Alt</kbd>+<kbd>R</kbd>   | Reload window (debug mode only)          |
-| `view.reload-images`    | <kbd>Command</kbd>+<kbd>R</kbd>                  | Reload images                            |
+| Id                      | Default                                           | Description                              |
+| ----------------------- | ------------------------------------------------- | ---------------------------------------- |
+| `view.command-palette`  | <kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd>  | Toggle command palette                   |
+| `view.source-code-mode` | <kbd>Command</kbd>+<kbd>Option</kbd>+<kbd>S</kbd> | Switch to source code mode               |
+| `view.typewriter-mode`  | <kbd>Command</kbd>+<kbd>Option</kbd>+<kbd>T</kbd> | Enable typewriter mode                   |
+| `view.focus-mode`       | <kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>J</kbd>  | Enable focus mode                        |
+| `view.toggle-sidebar`   | <kbd>Command</kbd>+<kbd>J</kbd>                   | Toggle sidebar                           |
+| `view.toggle-tabbar`    | <kbd>Command</kbd>+<kbd>Option</kbd>+<kbd>B</kbd> | Toggle tabbar                            |
+| `view.toggle-toc` .     | <kbd>Command</kbd>+<kbd>K</kbd>                   | Toggle table of contents                 |
+| `view.toggle-dev-tools` | <kbd>Command</kbd>+<kbd>Option</kbd>+<kbd>I</kbd> | Toggle developer tools (debug mode only) |
+| `view.dev-reload`       | <kbd>Command</kbd>+<kbd>Option</kbd>+<kbd>R</kbd> | Reload window (debug mode only)          |
+| `view.reload-images`    | <kbd>Command</kbd>+<kbd>R</kbd>                   | Reload images                            |
 
 ## Available key bindings