Merge branch 'master' into highlight-scroll-hints

Author: =

CHANGELOG.md

@@ -1,7 +1,23 @@
-2.3 (unreleased)
+2.3 (2025-06-30)
 
+- Add a command listing page, which documents all commands and their options. Access it
+  [on the web](https://vimium.github.io/commands/), or from the Vimium Options page > Show available
+  commands.
 - Some internal CSS classes were changed for Vimium's UI. This may affect those who have customized
-  Vimium's CSS via the options page. [#4668](https://github.com/philc/vimium/issues/4668).
+  Vimium's CSS via the options page. (https://github.com/philc/vimium/issues/4668)
+- Breaking change: when creating a mapping for `setZoom`, a `level` argument is now required.
+  E.g.: `map z2 setZoom level=2.0`.
+- Make `Vomnibar.activateBookmark` accept a `query` option.
+  (https://github.com/philc/vimium/pull/4591)
+- Fix `openCopiedUrlInCurrentTab` doesn't launch search queries.
+  (https://github.com/philc/vimium/issues/4657)
+- Make `openCopiedUrlInCurrentTab` accept a `position` option.
+- Update `goPrevious` and `goNext` commands to handle google.com's new layout.
+  (https://github.com/philc/vimium/issues/4650)
+- Add a "hide update notifications" option for silencing "Vimium has been updated" notifications.
+  (https://github.com/philc/vimium/issues/4346)
+- Use dark mode styles in the HUD when the browser is in dark mode.
+- Bug fixes.
 
 2.2.1 (2025-03-20)
 

README.md

@@ -3,10 +3,12 @@
 Vimium is a browser extension that provides keyboard-based navigation and control of the web in the
 spirit of the Vim editor.
 
+[Watch the demo video](https://www.youtube.com/watch?v=t67Sn0RGK54).
+
 **Installation instructions:**
 
 - Chrome:
-  [Chrome web store](https://chrome.google.com/extensions/detail/dbepggeogbaibhgnhhndojpepiihcmeb)
+  [Chrome web store](https://chromewebstore.google.com/detail/vimium/dbepggeogbaibhgnhhndojpepiihcmeb)
 - Edge:
   [Edge Add-ons](https://microsoftedge.microsoft.com/addons/detail/vimium/djmieaghokpkpjfbpelnlkfgfjapaopa)
 - Firefox: [Firefox Add-ons](https://addons.mozilla.org/en-GB/firefox/addon/vimium-ff/)
@@ -110,31 +112,32 @@ Vimium supports command repetition so, for example, hitting `5t` will open 5 tab
 succession. `<Esc>` (or `<c-[>`) will clear any partial commands in the queue and will also exit
 insert and find modes.
 
-There are some advanced commands which aren't documented here; refer to the help dialog (type `?`)
-for a full list.
+There are additional commands which aren't included in this README; refer to the help dialog (type `?`) for a
+full list.
 
 ## Custom Key Mappings
 
 You may remap or unmap any of the default key bindings in the "Custom key mappings" on the options
 page.
 
-Enter one of the following key mapping commands per line:
+Enter one of the following key mapping statements per line:
 
-- `map key command`: Maps a key to a Vimium command. Overrides Chrome's default behavior (if any).
+- `map key command`: Maps a key to a Vimium command. Overrides Chrome's default behavior for that
+  key, if any.
 - `unmap key`: Unmaps a key and restores Chrome's default behavior (if any).
 - `unmapAll`: Unmaps all bindings. This is useful if you want to completely wipe Vimium's defaults
   and start from scratch with your own setup.
 
 Examples:
 
 - `map <c-d> scrollPageDown` maps ctrl+d to scrolling the page down. Chrome's default behavior of
-  bringing up a bookmark dialog is suppressed.
-- `map r reload` maps the r key to reloading the page.
+  showing a bookmark dialog is suppressed.
+- `map r reload hard` maps the r key to reloading the page, and also includes the "hard"
+  option to hard-reload the page.
 - `unmap <c-d>` removes any mapping for ctrl+d and restores Chrome's default behavior.
 - `unmap r` removes any mapping for the r key.
 
-Available Vimium commands can be found via the "Show available commands" link near the key mapping
-box on the options page. The command name appears to the right of the description in parenthesis.
+See the [docs](https://vimium.github.io/commands/) for every Vimium command and its options.
 
 You can add comments to key mappings by starting a line with `"` or `#`.
 
@@ -153,9 +156,10 @@ keyboard.
 
 ## More documentation
 
-Many of the more advanced or involved features are documented on
-[Vimium's GitHub wiki](https://github.com/philc/vimium/wiki). Also see the
-[FAQ](https://github.com/philc/vimium/wiki/FAQ).
+* [FAQ](https://github.com/philc/vimium/wiki/FAQ)
+* [Command listing](https://vimium.github.io/commands/)
+* [Vimium's GitHub wiki](https://github.com/philc/vimium/wiki): documentation the more advanced
+  features.
 
 ## Contributing
 

background_scripts/all_commands.js

@@ -4,6 +4,7 @@
 // - advanced: advanced commands are not shown in the help dialog by default.
 // - background: whether this command has to be run by the background page.
 // - desc: shown in the help dialog and command listing page.
+// - details: extra help information that will only be shown on the command listing page.
 // - group: commands are displayed in groups in the help dialog and command listing.
 // - noRepeat: whether this command can be used with a count key prefix.
 // - repeatLimit: the number of allowed repetitions of this command before the user is prompted for
@@ -118,6 +119,10 @@ const allCommands = [
     desc: "Open the clipboard's URL in a new tab",
     group: "navigation",
     noRepeat: true,
+    options: {
+      position: "Where to place the tab in the tab bar. " +
+        "One of `start`, `before`, `after`, `end`. `after` is the default.",
+    },
   },
 
   {
@@ -159,6 +164,9 @@ const allCommands = [
   {
     name: "passNextKey",
     desc: "Pass the next key to the page",
+    options: {
+      normal: "Optional. Enter Vimium's normal mode, and ignore any defined pass keys.",
+    },
     group: "navigation",
     advanced: true,
   },
@@ -173,9 +181,8 @@ const allCommands = [
     name: "LinkHints.activateMode",
     desc: "Open a link in the current tab",
     options: {
-      action: "<code>action</code>: one of <code>hover</code>, <code>focus</code>, " +
-        "<code>copy-text</code>. When a link is selected, instead of clicking on the link, " +
-        "perform the specified action.",
+      action: "one of `hover`, `focus`, `copy-text`. When a link is selected, " +
+        "instead of clicking on the link, perform the specified action.",
     },
     group: "navigation",
     advanced: true,
@@ -256,14 +263,27 @@ const allCommands = [
   {
     name: "Marks.activateCreateMode",
     desc: "Create a new mark",
+    details: "Do this by typing the key bound to this command, and then a letter. " +
+      "This will set a mark bound to that letter. Lowercase letters are local marks and uppercase " +
+      "letters are global marks.",
+    options: {
+      swap: "Swap global and local marks. This option exists because in a browser, global marks " +
+        "are generally more useful than local marks, and so it may be desirable to make lowercase " +
+        "letters represent global marks rather than local marks.",
+    },
     group: "navigation",
     advanced: true,
     noRepeat: true,
   },
 
   {
     name: "Marks.activateGotoMode",
-    desc: "go to a mark",
+    desc: "Jump to a mark",
+    options: {
+      swap: "Swap global and local marks. This option exists because in a browser, global marks " +
+        "are generally more useful than local marks, and so it may be desirable to make lowercase " +
+        "letters represent global marks rather than local marks.",
+    },
     group: "navigation",
     advanced: true,
     noRepeat: true,
@@ -276,6 +296,11 @@ const allCommands = [
   {
     name: "Vomnibar.activate",
     desc: "Open URL, bookmark or history entry",
+    options: {
+      query: "The text to prefill the Vomnibar with.",
+      keyword: 'The keyword of a search engine defined in the "Custom search engines" ' +
+        "section of the Vimium Options page. The Vomnibar will be scoped to use that search engine.",
+    },
     group: "vomnibar",
     topFrame: true,
   },
@@ -284,20 +309,31 @@ const allCommands = [
     name: "Vomnibar.activateInNewTab",
     desc: "Open URL, bookmark or history entry in a new tab",
     group: "vomnibar",
+    options: {
+      query: "The text to prefill the Vomnibar with.",
+      keyword: 'The keyword of a search engine defined in the "Custom search engines" ' +
+        "section of the Vimium Options page. The Vomnibar will be scoped to use that search engine.",
+    },
     topFrame: true,
   },
 
   {
     name: "Vomnibar.activateBookmarks",
     desc: "Open a bookmark",
     group: "vomnibar",
+    options: {
+      query: "The text to prefill the Vomnibar with.",
+    },
     topFrame: true,
   },
 
   {
     name: "Vomnibar.activateBookmarksInNewTab",
     desc: "Open a bookmark in a new tab",
     group: "vomnibar",
+    options: {
+      query: "The text to prefill the Vomnibar with.",
+    },
     topFrame: true,
   },
 
@@ -382,6 +418,14 @@ const allCommands = [
   {
     name: "createTab",
     desc: "Create new tab",
+    options: {
+      "(any url)": "Open this URL, rather than the browser's new tab page. " +
+        "E.g.: `map X createTab https://example.com`",
+      window: "Create the tab in a new window",
+      incognito: "Create the tab in an incognito window",
+      position: "Where to place the tab in the tab bar. " +
+        "One of `start`, `before`, `after`, `end`. `after` is the default.",
+    },
     group: "tabs",
     background: true,
     repeatLimit: 20,
@@ -440,6 +484,10 @@ const allCommands = [
   {
     name: "toggleMuteTab",
     desc: "Mute or unmute current tab",
+    options: {
+      all: "Mute all tabs.",
+      other: "Mute every tab except the current one.",
+    },
     group: "tabs",
     background: true,
     noRepeat: true,
@@ -518,6 +566,9 @@ const allCommands = [
     group: "tabs",
     advanced: true,
     background: true,
+    options: {
+      level: "The zoom level. This can be a range of [0.25, 5.0]. 1.0 is the default.",
+    },
   },
 
   {