{"id":13596162,"url":"https://github.com/romainl/vim-devdocs","last_synced_at":"2025-05-14T11:33:43.655Z","repository":{"id":44089266,"uuid":"136729216","full_name":"romainl/vim-devdocs","owner":"romainl","description":"Look up keyword on https://devdocs.io from Vim","archived":false,"fork":false,"pushed_at":"2022-12-18T09:44:40.000Z","size":22,"stargazers_count":60,"open_issues_count":0,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-02T17:38:19.474Z","etag":null,"topics":["documentation","vim"],"latest_commit_sha":null,"homepage":null,"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/romainl.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":"2018-06-09T14:14:22.000Z","updated_at":"2025-01-23T09:40:58.000Z","dependencies_parsed_at":"2023-01-29T19:01:18.151Z","dependency_job_id":null,"html_url":"https://github.com/romainl/vim-devdocs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/romainl%2Fvim-devdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/romainl%2Fvim-devdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/romainl%2Fvim-devdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/romainl%2Fvim-devdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/romainl","download_url":"https://codeload.github.com/romainl/vim-devdocs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254131885,"owners_count":22020034,"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":["documentation","vim"],"created_at":"2024-08-01T16:02:10.640Z","updated_at":"2025-05-14T11:33:43.361Z","avatar_url":"https://github.com/romainl.png","language":"Vim Script","funding_links":[],"categories":["Vim script","Vim Script"],"sub_categories":[],"readme":"# vim-devdocs\n\nLook up keywords on [https://devdocs.io](https://devdocs.io) from Vim.\n\n## Introduction\n\nVim-devdocs is a very small and trivial plugin with a laser-focused purpose: looking up keywords on [https://devdocs.io](https://devdocs.io) from Vim.\n\nIt does so by providing a single command, `:DD`, that will figure out the current filetype and point your default browser to the web app with the correct query.\n\nEven better, `:DD` can be used under the hood by the built-in `K` for maximum street credibility.\n\nTo work its magic, vim-devdocs depends on:\n\n* `xdg-open` on various Unix-like systems, part of the `xdg-utils` package,\n* `open` on MacOS, it is installed by default,\n* `cmd.exe` on WSL, it is also installed by default,\n* `explorer` on Windows, it is also installed by default,\n\nbut you can tell it to use any external command with `'g:devdocs_open_command'`.\n\nWhether you use one of the standard commands above or a custom one, it is expected to handle URLs of the form:\n\n    https://devdocs.io/#q=javascript%20proxy\n\nOut of the box, the standard commands handle that URL by opening your default Web browser, which is the nominal, expected behavior.\n\n## Background\n\nVim-devdocs started its life in my config as an experimental snippet circa 2016, then became a clean and reusable Gist in mid-2017, which I decided to weaponize one year later. If you think a plugin should not be needed for such a trivial feature be reassured that I totally share that view. If you feel remix-y, [the original Gist](https://gist.github.com/romainl/8d3b73428b4366f75a19be2dad2f0987) is still up in all its 13LOC glory.\n\nNOTE: vim-devdocs is not affiliated in any way with [https://devdocs.io](https://devdocs.io) so any request pertaining to that site should be directed to its operators.\n\nNOTE: vim-devdocs relies entirely on the underlying command (see above) for the handling of the constructed URL. If, somehow, it doesn't behave as expected, refer to its documentation and/or use its official support channels.\n\n## Installation\n\n### Method 1\n\nUse your favorite runtimepath/plugin manager.\n\n### Method 2\n\nIf you are using Vim 8.0 or above, move this directory to:\n\n    # Unix-like systems\n    ~/.vim/pack/{whatever name you want}/start/vim-devdocs\n\n    # Windows\n    %userprofile%\\vimfiles\\pack\\{whatever name you want}\\start\\vim-devdocs\n\nSee `:help package`.\n\n### Method 3\n\nIf you are using Vim 7.4 without a runtimepath/plugin manager, move the files in this directory to their standard location:\n\n    # Unix-like systems\n    ~/.vim/doc/devdocs.txt\n    ~/.vim/plugin/devdocs.vim\n\n    # Windows\n    %userprofile%\\vimfiles\\doc\\devdocs.txt\n    %userprofile%\\vimfiles\\plugin\\devdocs.vim\n\nand make Vim aware of the plugin's documentation with:\n\n    :helptags ALL\n\n## Documentation\n\nYou can use this command to get help on vim-devdocs:\n\n    :help vim-devdocs\n\n## Configuration\n\nAdd the line below to your vimrc if you want to disable automatic filetype scoping:\n\n    let g:devdocs_enable_scoping = 0\n\nAdd the line below to your `vimrc` if you want to use a different \"opener\" than the default one:\n\n    let g:devdocs_open_command = \"my-command\"\n\n## Usage\n\nUse `:DD` without argument to look up the word under the cursor, scoped with the current filetype:\n\n    :DD\n\nUse `:DD [keyword]` to look up the given keyword, scoped with the current filetype:\n\n    :DD Map\n\nUse `:DD [filetype] [keyword]` to do the scoping yourself:\n\n    :DD scss @mixin\n\nAdd a `\u003cbang\u003e` to prevent automatic filetype scoping:\n\n    :DD!\n    :DD! Map\n\nunless you absolutely insist:\n\n    :DD! scss @mixin\n\nVim comes with the built-in and often overlooked `K`, a normal mode command that looks up the keyword under the cursor with the external command or Ex command set via the `'keywordprg'` option. `:DD` being a pretty basic Ex command it is easy to use it for `K`.\n\nIf you want `K` to ALWAYS use `:DD`, put this line in your vimrc:\n\n    set keywordprg=:DD\n\nIf you want `K` to use `:DD` ONLY for certain filetypes, put this line in the appropriate `after/ftplugin/\u003cfiletype\u003e.vim`:\n\n    setlocal keywordprg=:DD\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fromainl%2Fvim-devdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fromainl%2Fvim-devdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fromainl%2Fvim-devdocs/lists"}