From 27c68b6739a7d228bd58c917981a213f071a935d Mon Sep 17 00:00:00 2001 From: Alexey Sachkov Date: Tue, 19 Jun 2018 14:21:04 +0300 Subject: [PATCH] Update README --- README.md | 107 ++++++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 100 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index ac5501b..9835800 100644 --- a/README.md +++ b/README.md @@ -26,13 +26,45 @@ The default mappings are as follows: - b: Select tabs by URL or title - a: add current page to the bookmarks +See [console commands](#console-commands) section for more detailed description + #### Tabs +- d: delete tab - !d: delete pinned tab - u: reopen close tab - r: reload current tab - R: reload current tab without cache +- K or gT: select previous tab +- J or gt: select next tab +- g0: select first tab +- g$: select last tab +- Ctrl+6: open previously selected tab +- zp: pin tab +- zd: duplicate tab + +#### Scrolling + +- k: scroll down +- j: scroll up +- h: scroll left +- l: scroll right +- Ctrl+U: scroll up for a half page +- Ctrl+D: scroll down for a half page +- Ctrl+B: scroll up for a whole page +- Ctrl+F: scroll down for a whole page +- gg: scroll to top of a page +- G: scroll to bottom of a page +- 0: scroll to the leftmost part of a page +- $: scroll to the rightmost part of a page + +#### Zoom + +- zi: zoom in +- zo: zoom out +- zz: zoom neutral (reset) + +#### Navigation -### Navigation - f: start following links in the page in the current tab - F: start following links in the page in new tabs - H: go back in history @@ -42,6 +74,17 @@ The default mappings are as follows: - gU: go to root directory - gi: 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 - y: 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 :. Or start it with initial values using -o, t, or w. +o/O, t/T, +or w/W. #### `: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 a 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 +shift+Esc. ## Licence