{"id":13898256,"url":"https://github.com/bfrg/vim-cmake-help","last_synced_at":"2026-03-13T23:34:51.965Z","repository":{"id":39988911,"uuid":"224445157","full_name":"bfrg/vim-cmake-help","owner":"bfrg","description":"View CMake Documentation inside Vim","archived":false,"fork":false,"pushed_at":"2025-07-13T11:20:30.000Z","size":48,"stargazers_count":6,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-07-13T13:19:03.334Z","etag":null,"topics":["cmake","vim","vim-cmake","vim-ftplugin","vim-plugin","vim9script"],"latest_commit_sha":null,"homepage":"","language":"Vim Script","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bfrg.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-11-27T14:08:52.000Z","updated_at":"2025-07-13T11:20:33.000Z","dependencies_parsed_at":"2024-10-30T16:13:15.386Z","dependency_job_id":"0af737b1-d38d-424e-b0ee-34b38d917760","html_url":"https://github.com/bfrg/vim-cmake-help","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/bfrg/vim-cmake-help","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bfrg%2Fvim-cmake-help","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bfrg%2Fvim-cmake-help/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bfrg%2Fvim-cmake-help/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bfrg%2Fvim-cmake-help/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bfrg","download_url":"https://codeload.github.com/bfrg/vim-cmake-help/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bfrg%2Fvim-cmake-help/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30479438,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-13T20:45:58.186Z","status":"ssl_error","status_checked_at":"2026-03-13T20:45:20.133Z","response_time":60,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["cmake","vim","vim-cmake","vim-ftplugin","vim-plugin","vim9script"],"created_at":"2024-08-06T18:04:11.532Z","updated_at":"2026-03-13T23:34:51.959Z","avatar_url":"https://github.com/bfrg.png","language":"Vim Script","readme":"# vim-cmake-help\n\nView [CMake][cmake] documentation inside Vim (`\u003e= 8.2.4980`).\n\nThe plugin provides three methods for quickly displaying CMake documentation:\n1. Open the documentation in a new split window.\n2. Open the documentation in a popup window at the current cursor position (or\n   mouse pointer).\n3. Open the [CMake Reference Documentation][cmake-doc] directly in your browser.\n\n![out](https://user-images.githubusercontent.com/6266600/102029974-0954f300-3db1-11eb-848d-79750528e9f5.png)\n\n\n## Usage\n\n### Commands\n\n| Command                    | Description                                                   |\n| -------------------------- | ------------------------------------------------------------- |\n| `:CMakeHelp {arg}`         | Open the CMake documentation for `{arg}` in a preview window. |\n| `:CMakeHelpPopup {arg}`    | Open the CMake documentation for `{arg}` in a popup window.   |\n| `:CMakeHelpOnline [{arg}]` | Open the online CMake documentation for `{arg}` in a browser. |\n\n`{arg}` can be any standard CMake keyword. Use \u003ckbd\u003eTAB\u003c/kbd\u003e in command-line\nmode for argument completion and to get a list of supported keywords.\n\nThese commands are all buffer local and only available with `filetype=cmake`.\n\n#### Example\n\nTo open the CMake documentation for the word under the cursor in a popup window with\n\u003ckbd\u003eK\u003c/kbd\u003e, add the following to `~/.vim/after/ftplugin/cmake.vim`:\n```vim\nvim9script\nsetlocal keywordprg=:CMakeHelpPopup\n```\n\n### Mappings\n\nFor convenience, the following `\u003cplug\u003e` mapping can be used instead of the\ncommands:\n\n| Mapping                    | Description                                                                     |\n| -------------------------- | ------------------------------------------------------------------------------- |\n| `\u003cplug\u003e(cmake-help)`       | Open the CMake documentation for the word under the cursor in a preview window. |\n| `\u003cplug\u003e(cmake-help-popup)` | Open the CMake documentation for the word under the cursor in a popup window.   |\n| `\u003cplug\u003e(cmake-help-online)`| Open the online CMake documentation for the word under the cursor in a browser. |\n\n#### Example\n\nAdd the following to `~/.vim/after/ftplugin/cmake.vim`:\n```vim\nvim9script\n\n# Open the online CMake documentation for current word in a browser\nnmap \u003cbuffer\u003e \u003cleader\u003ek \u003cplug\u003e(cmake-help-online)\n\n# Open CMake documentation for current word in a preview window\nnmap \u003cbuffer\u003e \u003cleader\u003eK \u003cplug\u003e(cmake-help)\n```\n\n### Popup window\n\nIf the documentation doesn't fit into the popup window, a scrollbar will appear\non the right side. The popup window can then be scrolled with\n\u003ckbd\u003eS-PageUp\u003c/kbd\u003e and \u003ckbd\u003eS-PageDown\u003c/kbd\u003e, or alternatively, using the mouse\nwheel. Pressing \u003ckbd\u003eCTRL-C\u003c/kbd\u003e or moving the cursor in any direction will\nclose the popup window.\n\nThe keys for scrolling the popup window are configurable.\n\n### Mouse hovers\n\nThe plugin provides a `balloonexpr` that will open the CMake documentation for\nthe word under the mouse pointer in a popup window. To enable this feature, add\nthe following to `~/.vim/after/ftplugin/cmake.vim`:\n```vim\nvim9script\n\nimport autoload 'cmakehelp.vim'\n\nsetlocal ballooneval\nsetlocal balloonevalterm\nsetlocal balloonexpr=cmakehelp.Balloonexpr()\n```\nMoving the mouse pointer outside the current word closes the popup window.\n\n\n## Configuration\n\n### `g:cmakehelp` and `b:cmakehelp`\n\nOptions can be set either through the buffer-local variable `b:cmakehelp`\n(specified for `cmake` filetypes), or the global variable `g:cmakehelp`. The\nvariable must be a dictionary containing any of the following entries:\n\n| Key           | Description                                                         | Default               |\n| ------------- | ------------------------------------------------------------------- | --------------------- |\n| `exe`         | Path to `cmake` executable.                                         | value found in `$PATH`|\n| `browser`     | Browser executable.                                                 | `firefox`             |\n| `scrollup`    | Key for scrolling the text up in the popup window.                  | \u003ckbd\u003eS-PageUp\u003c/kbd\u003e   |\n| `scrolldown`  | Key for scrolling the text down in the popup window.                | \u003ckbd\u003eS-PageDown\u003c/kbd\u003e |\n| `maxheight`   | Maximum height for popup window. Set to `0` for maximum available.  | `0`                   |\n| `top`         | Key for jumping to the top of the buffer in the popup window.       | \u003ckbd\u003eS-Home\u003c/kbd\u003e     |\n| `bottom`      | Key for jumping to the botton of the buffer in the popup window.    | \u003ckbd\u003eS-End\u003c/kbd\u003e      |\n\nExample:\n```vim\nvim9script\n\ng:cmakehelp = {\n    exe: expand('~/.local/bin/cmake'),\n    browser: 'xdg-open',\n    maxheight: 20,\n    scrollup: \"\\\u003cc-k\u003e\",\n    scrolldown: \"\\\u003cc-j\u003e\",\n    top: \"\\\u003cc-t\u003e\",\n    bottom: \"\\\u003cc-g\u003e\"\n}\n```\n\n### Popup highlightings\n\nThe appearance of the popup window can be configured through the following\nhighlight groups:\n\n| Highlight group     | Description                             | Default     |\n| ------------------- | --------------------------------------- | ----------- |\n| `CMakeHelp`         | Popup window background and normal text.| `Pmenu`     |\n| `CMakeHelpScrollbar`| Scrollbar of popup window.              | `PmenuSbar` |\n| `CMakeHelpThumb`    | Thumb of scrollbar.                     | `PmenuThumb`|\n\n\n## Installation\n\n```bash\n$ cd ~/.vim/pack/git-plugins/start\n$ git clone https://github.com/bfrg/vim-cmake-help\n$ vim -u NONE -c 'helptags vim-cmake-help/doc | quit'\n```\n**Note:** The directory name `git-plugins` is arbitrary, you can pick any other\nname. For more details see `:help packages`. Alternatively, use your favorite\nplugin manager.\n\n\n## License\n\nDistributed under the same terms as Vim itself. See `:help license`.\n\n[cmake]: https://cmake.org\n[cmake-doc]: https://cmake.org/cmake/help/latest/index.html\n","funding_links":[],"categories":["Integrations","Vim Script"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbfrg%2Fvim-cmake-help","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbfrg%2Fvim-cmake-help","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbfrg%2Fvim-cmake-help/lists"}