diff options
| -rw-r--r-- | README.md | 107 |
1 files changed, 100 insertions, 7 deletions
@@ -26,13 +26,45 @@ The default mappings are as follows: - <kbd>b</kbd>: Select tabs by URL or title - <kbd>a</kbd>: add current page to the bookmarks +See [console commands](#console-commands) section for more detailed description + #### Tabs +- <kbd>d</kbd>: delete tab - <kbd>!</kbd><kbd>d</kbd>: delete pinned tab - <kbd>u</kbd>: reopen close tab - <kbd>r</kbd>: reload current tab - <kbd>R</kbd>: reload current tab without cache +- <kbd>K</kbd> or <kbd>g</kbd><kbd>T</kbd>: select previous tab +- <kbd>J</kbd> or <kbd>g</kbd><kbd>t</kbd>: select next tab +- <kbd>g</kbd><kbd>0</kbd>: select first tab +- <kbd>g</kbd><kbd>$</kbd>: select last tab +- <kbd>Ctrl</kbd>+<kbd>6</kbd>: open previously selected tab +- <kbd>z</kbd><kbd>p</kbd>: pin tab +- <kbd>z</kbd><kbd>d</kbd>: duplicate tab + +#### Scrolling + +- <kbd>k</kbd>: scroll down +- <kbd>j</kbd>: scroll up +- <kbd>h</kbd>: scroll left +- <kbd>l</kbd>: scroll right +- <kbd>Ctrl</kbd>+<kbd>U</kbd>: scroll up for a half page +- <kbd>Ctrl</kbd>+<kbd>D</kbd>: scroll down for a half page +- <kbd>Ctrl</kbd>+<kbd>B</kbd>: scroll up for a whole page +- <kbd>Ctrl</kbd>+<kbd>F</kbd>: scroll down for a whole page +- <kbd>g</kbd><kbd>g</kbd>: scroll to top of a page +- <kbd>G</kbd>: scroll to bottom of a page +- <kbd>0</kbd>: scroll to the leftmost part of a page +- <kbd>$</kbd>: scroll to the rightmost part of a page + +#### Zoom + +- <kbd>z</kbd><kbd>i</kbd>: zoom in +- <kbd>z</kbd><kbd>o</kbd>: zoom out +- <kbd>z</kbd><kbd>z</kbd>: zoom neutral (reset) + +#### Navigation -### Navigation - <kbd>f</kbd>: start following links in the page in the current tab - <kbd>F</kbd>: start following links in the page in new tabs - <kbd>H</kbd>: go back in history @@ -42,6 +74,17 @@ The default mappings are as follows: - <kbd>g</kbd><kbd>U</kbd>: go to root directory - <kbd>g</kbd><kbd>i</kbd>: focus first input +Plugin can be configured to follow links in new tabs in background instead of +switching to a new tab immediately. To do this you need to update config file: +change `"background"` property of `"follow.start"` action to true: +```json +{ + "keymaps": { + "F": { "type": "follow.start", "newTab": true, "background": true }, + } +} +``` + #### Misc - <kbd>y</kbd>: copy URL in current tab @@ -58,7 +101,8 @@ The default mappings are as follows: Vim Vixen provides a console for `ex`-style commands similar to Vimperator. Open the console with <kbd>:</kbd>. Or start it with initial values using -<kbd>o</kbd>, <kbd>t</kbd>, or <kbd>w</kbd>. +<kbd>o</kbd>/<kbd>O</kbd>, <kbd>t</kbd>/<kbd>T</kbd>, +or <kbd>w</kbd>/<kbd>W</kbd>. #### `:open` command @@ -95,10 +139,22 @@ Close the current tab. Close a certain tab. +You can add `!` at the end of the command to close tab even if it is pinned: + +``` +:bdelete! +``` + #### `:bdeletes` command Close tabs matches with keywords. +You can add `!` at the end of the command to close even pinned tabs: + +``` +:bdeletes! +``` + #### `:winopen` command Open a URL or search keywords by search engine in new window. @@ -107,19 +163,51 @@ Open a URL or search keywords by search engine in new window. Select tabs by URL or title matched by keywords. +#### `:addbookmark` command + +Create a bookmark from the current URL. + +``` +:addbookmark My bookmark title +``` + +The key map <kbd>a</kbd> is a contenient way to create a bookmark from the +current page. That shows `:addbookmark` with a title from the current page into +console. + #### `:set` command -`:set` command can set properties on console. +`:set` command can temporary override properties using console. See +[properties](#properties) section for more detailed description of available +properties. + +### Properties + +Plugin supports configurable properties which can be configured in JSON +settings: + +```json +{ + "properties": { + "adjacenttab": false + } +} +``` -##### `smoothscroll` property +Properties can be temporary overwritten by `:set` command in console. + +List of available properties you can find below: + +#### `smoothscroll` property Enable/disable smooth scroll. + ``` :set smoothscroll " enable smooth scroll :set nosmoothscroll " disable smooth scroll ``` -##### `hintchars` property +#### `hintchars` property Set hint characters @@ -127,7 +215,7 @@ Set hint characters :set hintchars=0123456789 ``` -##### 'adjacenttab' property +#### `adjacenttab` property Open a new tab on adjacent of the current tab. @@ -136,6 +224,10 @@ Open a new tab on adjacent of the current tab. :set adjacenttab " open a tab adjacently ``` +For developers and contributors: you can look at +[#303](https://github.com/ueokande/vim-vixen/pull/303) for more details about +properties implementation and usage. + ### Search engines Vim Vixen supports search by search engines like Google and Yahoo. @@ -175,7 +267,8 @@ In addition, you can also specify path patterns, such as `"example.com/mail/*"`. } ``` -You can toggle Vim Vixen between disabled and enabled with `shift + Esc`. +You can toggle Vim Vixen between disabled and enabled with +<kbd>shift</kbd>+<kbd>Esc</kbd>. ## Licence |