From 1220f7de763da3ac32dece9c136903db53c2c48d Mon Sep 17 00:00:00 2001 From: Simon Lydell Date: Thu, 14 Jan 2016 20:51:28 +0100 Subject: [PATCH] Improve docs regarding adding shortcuts to custom commands --- documentation/api.md | 6 +++--- documentation/config-file.md | 6 ++++++ 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/documentation/api.md b/documentation/api.md index ee30aed..d68d9c3 100644 --- a/documentation/api.md +++ b/documentation/api.md @@ -132,9 +132,9 @@ authors who wish to extend VimFx. They should add commands manually to `fn` is called when the command is activated. See the [onInput] documentation below for more information. -Note that you have to give the new command a shortcut in VimFx’s settings page -in the Add-ons Manager or set one using `vimfx.set()` to able to use the new -command. +Note that you have to give the +new command a shortcut in VimFx’s settings page in the Add-ons Manager or set +one using `vimfx.set()` to able to use the new command. ```js vimfx.addCommand({ diff --git a/documentation/config-file.md b/documentation/config-file.md index 5433f18..983bbc3 100644 --- a/documentation/config-file.md +++ b/documentation/config-file.md @@ -46,12 +46,18 @@ them in a place where Firefox can find them. This is the actual config file, written in JavaScript. It is in this file you add custom commands and set options, or whatever you’d like to do. +If you add custom commands, remember to [add shortcuts to +them][custom-command-shortcuts]! + Example: ```js vimfx.set('hint_chars', 'abcdefghijklmnopqrstuvwxyz') +vimfx.set('custom.mode.normal.zoom_in', 'zi') ``` +[custom-command-shortcuts]: api.md#user-content-custom-command-shortcuts + ## frame.js -- 2.39.3