{"id":13898472,"url":"https://github.com/rBrda/myKeymap","last_synced_at":"2025-07-17T15:33:39.878Z","repository":{"id":49498784,"uuid":"310618736","full_name":"rBrda/myKeymap","owner":"rBrda","description":"A simple plugin to list and search key mappings in (neo)vim. Based on fzf.vim.","archived":false,"fork":false,"pushed_at":"2020-11-11T23:23:07.000Z","size":9,"stargazers_count":10,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-08-07T18:46:35.091Z","etag":null,"topics":["fzf","neovim","neovim-plugin","vim","vim-plugins"],"latest_commit_sha":null,"homepage":"","language":"Vim script","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rBrda.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-11-06T14:26:21.000Z","updated_at":"2023-01-02T21:43:00.000Z","dependencies_parsed_at":"2022-08-28T03:01:25.217Z","dependency_job_id":null,"html_url":"https://github.com/rBrda/myKeymap","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rBrda%2FmyKeymap","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rBrda%2FmyKeymap/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rBrda%2FmyKeymap/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rBrda%2FmyKeymap/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rBrda","download_url":"https://codeload.github.com/rBrda/myKeymap/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226274922,"owners_count":17598861,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["fzf","neovim","neovim-plugin","vim","vim-plugins"],"created_at":"2024-08-06T18:04:18.658Z","updated_at":"2024-11-25T04:31:42.159Z","avatar_url":"https://github.com/rBrda.png","language":"Vim script","funding_links":[],"categories":["Vim Script"],"sub_categories":[],"readme":"# myKeymap\n\nA simple plugin to list and search key mappings in (neo)vim.\n\nBased on [fzf.vim](https://github.com/junegunn/fzf.vim).\n\n![mykeymap](https://user-images.githubusercontent.com/22145465/98745430-d84d6100-23b3-11eb-8c89-10869b23e458.png)\n\n## Usage\n\nLet's suppose you defined the following key mappings to navigate between open windows more easily. They look like this:\n\n```vim\n\" Navigating between open windows\nnnoremap \u003cC-l\u003e \u003cC-W\u003el\nnnoremap \u003cC-h\u003e \u003cC-W\u003eh\nnnoremap \u003cC-k\u003e \u003cC-W\u003ek\nnnoremap \u003cC-j\u003e \u003cC-W\u003ej\n```\n\nWith the help of this plugin you can add annotations to your key mappings. This way the plugin will be able to find them and list them for you.\n\n```vim\n\" Navigating between open windows\n\" @(Windows -\u003e right)\nnnoremap \u003cC-l\u003e \u003cC-W\u003el\n\" @(Windows -\u003e left)\nnnoremap \u003cC-h\u003e \u003cC-W\u003eh\n\" @(Windows -\u003e up)\nnnoremap \u003cC-k\u003e \u003cC-W\u003ek\n\" @(Windows -\u003e down)\nnnoremap \u003cC-j\u003e \u003cC-W\u003ej\n```\n\n### How to add annotations to your key bindings?\n\nThe annotation must be placed just above the key mapping it belongs to, like this:\n\n```vim\n\" @(Shift indentation)\nvnoremap \u003cTab\u003e \u003egv\n```\nUse descriptive naming for your key mappings, this way it's easier to search them.\n\nNote: you must restart your editor whenever you added or modified the annotations of your key mappings!\n\n### How to list and search your annotated key mappings?\n\nThe plugin has the `MyKeymap` command for listing the annotated key mappings. They will be shown in a fzf popup window.\n\n## Installation\n\nIt requires [fzf.vim](https://github.com/junegunn/fzf.vim) to be installed!\n\nWith [vim-plug](https://github.com/junegunn/vim-plug):\n```\nPlug 'junegunn/fzf', { 'do': { -\u003e fzf#install() } }\nPlug 'junegunn/fzf.vim'\nPlug 'rBrda/myKeymap'\n```\n\n## Configuration\n\nYou can configure the plugin by setting the following global variable in your (neo)vim configuration file (here you see all the properties included that can be modified):\n\n```vim\nlet g:myKeymapSettings = {\n  \\ 'show_details': ['action'],\n  \\ 'disable_cache': 0,\n  \\ }\n```\n\n### `g:myKeymapSettings.show_details`\n\nDefault value: `['action']`\n\nPossible values: `['action', 'source']`\n\nThis is a list of details that can be shown in the result list about the key mapping.\n\nMeaning of the available values:\n* `action` : shows the mapped command of the key mapping\n* `source` : shows the source file and line number of the key mapping\n\n### `g:myKeymapSettings.disable_cache`\n\nDefault value: `0`\n\nIf the cache is turned off (`1`), the plugin will always read your (neo)vim configuration files when the `MyKeymap` command is issued.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FrBrda%2FmyKeymap","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FrBrda%2FmyKeymap","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FrBrda%2FmyKeymap/lists"}