aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorShin'ya Ueoka <ueokande@i-beam.org>2017-10-21 08:36:41 +0900
committerGitHub <noreply@github.com>2017-10-21 08:36:41 +0900
commit941073404b534d7f79e90f29b514a5f06fb8080d (patch)
tree24bfd35960f9e0bf2d5ed15a4713e6af2bdf1c51
parentc47a2075bcada9dbb1ab1076a92238d6ce48d347 (diff)
parentb13b00fd85d1f7cae3529ff02cebc3422e42b45d (diff)
Merge pull request #85 from ueokande/use-kbd-tags
Use <kbd> tags
-rw-r--r--QA.md56
-rw-r--r--README.md52
2 files changed, 54 insertions, 54 deletions
diff --git a/QA.md b/QA.md
index 2549cc0..f9c4109 100644
--- a/QA.md
+++ b/QA.md
@@ -6,50 +6,50 @@ Test operations with default key maps.
##### Scrolling
-- [ ] `k`/`<C-Y>`,`j`/`<C-E>`: scroll up and down
-- [ ] `h`,`l`: scroll left and right
-- [ ] `<C-U>`,`<C-D>`: scroll up and down by half of screen
-- [ ] `<C-B>`,`<C-F>`: scroll up and down by a screen
-- [ ] `0`,`$`: scroll to leftmost and rightmost
-- [ ] `gg`,`G`: scroll to top and bottom
+- [ ] <kbd>k</kbd> or <kbd>Ctrl</kbd>+<kbd>Y</kbd>, <kbd>j</kbd> or <kbd>Ctrl</kbd>+<kbd>E</kbd>: scroll up and down
+- [ ] <kbd>h</kbd>, <kbd>l</kbd>: scroll left and right
+- [ ] <kbd>Ctrl</kbd>+<kbd>U</kbd>, <kbd>Ctrl</kbd>+<kbd>D</kbd>: scroll up and down by half of screen
+- [ ] <kbd>Ctrl</kbd>+<kbd>B</kbd>, <kbd>Ctrl</kbd>+<kbd>F</kbd>: scroll up and down by a screen
+- [ ] <kbd>0</kbd>, <kbd>$</kbd>: scroll to leftmost and rightmost
+- [ ] <kbd>g</kbd><kbd>g</kbd>, <kbd>G</kbd>: scroll to top and bottom
##### Console
The behaviors of the console are tested in [Console section](#consoles).
-- [ ] `:`: open empty console
-- [ ] `o`,`t`,`w`: open a console with `open`,`tabopen`,`winopen`
-- [ ] `O`,`T`,`W`: open a console with `open`,`tabopen`,`winopen` and current URL
-- [ ] `b`: open a consolw with `buffer`
+- [ ] <kbd>:</kbd>: open empty console
+- [ ] <kbd>o</kbd>, <kbd>t</kbd>, <kbd>w</kbd>: open a console with `open`, `tabopen`, `winopen`
+- [ ] <kbd>O</kbd>, <kbd>T</kbd>, <kbd>W</kbd>: open a console with `open`, `tabopen`, `winopen` and current URL
+- [ ] <kbd>b</kbd>: open a consolw with `buffer`
##### Tabs
-- [ ] `d`: delete current tab
-- [ ] `u`: reopen close tab
-- [ ] `K`,`J`: select prev and next tab
-- [ ] `r`: reload current tab
-- [ ] `R`: reload current tab without cache
+- [ ] <kbd>d</kbd>: delete current tab
+- [ ] <kbd>u</kbd>: reopen close tab
+- [ ] <kbd>K</kbd>, <kbd>J</kbd>: select prev and next tab
+- [ ] <kbd>r</kbd>: reload current tab
+- [ ] <kbd>R</kbd>: reload current tab without cache
##### Navigation
-- [ ] `f`: start following links
-- [ ] `F`: start following links and open in new tab
-- [ ] `H`,`L`: go back and forward in histories
-- [ ] `[[`,`]]`: find prev and next links and open it
-- [ ] `gu`: go to parent directory
-- [ ] `gU`: go to root directory
+- [ ] <kbd>f</kbd>: start following links
+- [ ] <kbd>F</kbd>: start following links and open in new tab
+- [ ] <kbd>H</kbd>, <kbd>L</kbd>: go back and forward in histories
+- [ ] <kbd>[</kbd><kbd>[</kbd>, <kbd>]</kbd><kbd>]</kbd>: find prev and next links and open it
+- [ ] <kbd>g</kbd><kbd>u</kbd>: go to parent directory
+- [ ] <kbd>g</kbd><kbd>U</kbd>: go to root directory
##### Misc
-- [ ] `zi`,`zo`: zoom-in and zoom-out
-- [ ] `zz`: set zoom level as default
-- [ ] `y`: yank current URL and show a message
+- [ ] <kbd>z</kbd><kbd>i</kbd>, <kbd>z</kbd><kbd>o</kbd>: zoom-in and zoom-out
+- [ ] <kbd>z</kbd><kbd>z</kbd>: set zoom level as default
+- [ ] <kbd>y</kbd>: yank current URL and show a message
#### Consoles
##### Exec a command
-- [ ] `<EMPTY>`,`<SP>`: do nothing
+- [ ] `<EMPTY>`, `<SP>`: do nothing
<br>
- [ ] `open an apple`: search with keywords "an apple" by default search engine (google)
@@ -111,7 +111,7 @@ The behaviors of the console are tested in [Console section](#consoles).
#### Events are fired on Slack and Twitter (#54)
-- [ ] Fucus text box on Twitter or Slack, press `j`, then `j` is typed in the box
+- [ ] Fucus text box on Twitter or Slack, press <kbd>j</kbd>, then <kbd>j</kbd> is typed in the box
- [ ] Focus the text box on Twitter or Slack on following mode
#### Multi frame support (#61)
@@ -119,8 +119,8 @@ The behaviors of the console are tested in [Console section](#consoles).
- [ ] Show hints on following on a page containing `<frame>`/`<iframe>`
- [ ] Show hints only inside viewport of the frame on following on a page containing `<frame>`/`<iframe>`
- [ ] Show hints only inside top window on following on a page containing `<frame>`/`<iframe>`
-- [ ] Select link and open it in the frame in `<iframe>`/`<frame`> on following by `f`
-- [ ] Select link and open it in new tab in `<iframe>`/`<frame`> on following by `F`
+- [ ] Select link and open it in the frame in `<iframe>`/`<frame`> on following by <kbd>f</kbd>
+- [ ] Select link and open it in new tab in `<iframe>`/`<frame`> on following by <kbd>F</kbd>
#### Empty suggestion (#65)
diff --git a/README.md b/README.md
index f742d42..066a706 100644
--- a/README.md
+++ b/README.md
@@ -14,45 +14,45 @@ The default mapping are shown in the following.
#### Console
-- `:`: open console
-- `o`,`t`,`w`: open a page in current tab, new tab, or new window
-- `O`,`T`,`W`: similar to `o`,`t`,`w`, but that contains current URL
-- `b`: Select tabs by URL or title
+- <kbd>:</kbd>: open console
+- <kbd>o</kbd>, <kbd>t</kbd>, <kbd>w</kbd>: open a page in current tab, new tab, or new window
+- <kbd>O</kbd>, <kbd>T</kbd>, <kbd>W</kbd>: similar to <kbd>o</kbd>, <kbd>t</kbd>, <kbd>w</kbd>, but that contains current URL
+- <kbd>b</kbd>: Select tabs by URL or title
#### Scrolling
-- `j`,`k`: scroll vertically
-- `h`,`l`: scroll horizontally
-- `<C-U>`,`<C-D>`: scroll pages by half of screen
-- `<C-B>`,`<C-F>`: scroll pages by a screen
-- `0`,`$`: scroll a page to leftmost/rightmost
-- `gg`,`G`: scroll to top/bottom
+- <kbd>j</kbd>, <kbd>k</kbd>: scroll vertically
+- <kbd>h</kbd>, <kbd>l</kbd>: scroll horizontally
+- <kbd>Ctrl</kbd>+<kbd>U</kbd>, <kbd>Ctrl</kbd>+<kbd>D</kbd>: scroll pages by half of screen
+- <kbd>Ctrl</kbd>+<kbd>B</kbd>, <kbd>Ctrl</kbd>+<kbd>F</kbd>: scroll pages by a screen
+- <kbd>0</kbd>, <kbd>$</kbd>: scroll a page to leftmost/rightmost
+- <kbd>g</kbd><kbd>g</kbd>, <kbd>G</kbd>: scroll to top/bottom
#### Tabs
-- `d`: delete current tab
-- `u`: reopen close tab
-- `K`/`J`: select prev/next tab
-- `r`: reload current tab
-- `R`: reload current tab without cache
+- <kbd>d</kbd>: delete current tab
+- <kbd>u</kbd>: reopen close tab
+- <kbd>K</kbd>, <kbd>J</kbd>: select prev or next tab
+- <kbd>r</kbd>: reload current tab
+- <kbd>R</kbd>: reload current tab without cache
### Navigation
-- `f`: start following links in the page
-- `H`: go back in histories
-- `L`: go forward in histories
-- `[[`,`]]`: find prev/next links and open it
-- `gu`: go to parent directory
-- `gU`: go to root directory
+- <kbd>f</kbd>: start following links in the page
+- <kbd>H</kbd>: go back in histories
+- <kbd>L</kbd>: go forward in histories
+- <kbd>[</kbd><kbd>[</kbd>, <kbd>]</kbd><kbd>]</kbd>: find prev or next links and open it
+- <kbd>g</kbd><kbd>u</kbd>: go to parent directory
+- <kbd>g</kbd><kbd>U</kbd>: go to root directory
#### Misc
-- `zi`,`zo`: zoom-in/zoom-out
-- `zz`: Set default zoom level
-- `y`: copy URL in current tab
+- <kbd>z</kbd><kbd>i</kbd>, <kbd>z</kbd><kbd>o</kbd>: zoom-in/zoom-out
+- <kbd>z</kbd><kbd>z</kbd>: Set default zoom level
+- <kbd>y</kbd>: copy URL in current tab
### Console commands
Vim-Vixen provides a console likes Vimperator's one.
-The console is opened by `:` key or keys to open console with initial value
-likes `o`, `t`, or `w` keys.
+The console is opened by <kbd>:</kbd> key or keys to open console with initial value
+likes <kbd>o</kbd>, <kbd>t</kbd>, or <kbd>w</kbd> keys.
#### `:open` command