GitHub - rhysd/devdocs.vim: Open devdocs.io from Vim
source link: https://github.com/rhysd/devdocs.vim
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
devdocs.vim
This is a Vim plugin for devdocs, which is an awesome multiple API documentation service. You can open and search devdocs from Vim.
- Open and search devdocs using command
:DevDocs
or:DevDocsAll
- Relate filetype to specific documentation.
- Search word under the cursor.
Usage
:DevDocs [query]
: Search with query with filetype related documentation (query
can be omitted):DevDocsAll [query]
: Search with query with all documentation (query
can be omitted)
Customize
Mapping K
to search under the word quickly
devdocs.vim doesn't overrides any mapping by default. You should define key mappings if you need.
If you always want to override K
mapping,
nmap K <Plug>(devdocs-under-cursor)
If you want to override K
mapping in specific filetypes,
augroup plugin-devdocs
autocmd!
autocmd FileType c,cpp,rust,haskell,python nmap <buffer>K <Plug>(devdocs-under-cursor)
augroup END
Above replaces K
in C, C++, Rust, Haskell, and Python.
Open with specific documentation on specific filetype
You can customize relationship between Vim's filetype and documentation. Below is an example of customization.
let g:devdocs_filetype_map = {
\ 'ruby': 'rails',
\ 'javascript.jsx': 'react',
\ 'javascript.test': 'chai',
\ }
With above configuration, :DevDocs blah
searches Rails documentation on filetype ruby
.
:DevDocsAll
searches all documentation ignoring filetype relation and below configuration explicitly
disables this feature.
let g:devdocs_filetype_map = { '*': '' }
Open local devdocs
You can easily host local devdocs. If your local
devdocs is hosted at localhost:9292
, devdocs.vim uses it by following configuration.
let g:devdocs_host = 'localhost:9292'
If you use http://
to host your DevDocs instance, please use g:devdocs_url
variable to specify
an http://
scheme.
let g:devdocs_url = 'http://localhost:9292'
Make a command for specific document
You can use devdocs#open_doc()
function to make such a command.
Below is an example for :DevDocsReact
command to open page with 'react' documentation
command! -nargs=* DevDocsReact call devdocs#open_doc(<q-args>, 'react')
You can execute as below,
:DevDocsReact
:DevDocsReact componentDidMount
Open in non-default browser
devdocs.vim opens URL with open-browser.vim at first.
If it is not installed, it tries to open default browser. If you don't install open-browser.vim and
want to use non-default browser, please use g:devdocs_open_cmd
to specify what command should be
used for opening a browser.
" Open devdocs.io in Safari on macOS
let g:devdocs_open_cmd = 'open -a Safari'
" Open devdocs.io in Firefox on Linux
let g:devdocs_open_cmd = 'firefox'
License
Copyright (c) 2015 rhysd
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Recommend
-
105
Operator to Surround a Text Object This plugin provides Vim operator mappings to deal with surrounds like (), "" and so on. In addition, both end of the text object are the same character, vim-operator-surround r...
-
107
DevDocs — API Documentation Browser DevDocs combines multiple developer documentations in a clean and organized web UI with instant search, offline support, mobile version, dark theme, key...
-
41
README.md
-
55
GitHub is where people build software. More than 27 million people use GitHub to discover, fork, and contribute to over 80 million projects.
-
38
Fast, offline, and free documentation browser for developers. Search 100+ docs in one web app: HTML, CSS, JavaScript, PHP, Ruby, Python, Go, C, C++…
-
15
Emacs Devdocs Browser Browse devdocs.io documents inside Emacs! Features Browse API documentations provided by devdocs.io inside Emacs using
-
14
devdocs.el — Emacs viewer for DevDocs devdocs.el is a documentation viewer similar to the built-in Info browser, but geared towards documentation obtained from the DevDocs website. The stable versio...
-
2
DevDocs — Composer documentation You're browsing the Composer documentation. To browse all docs, go to devdocs.io (or press esc).
-
5
Copy link Contributor rhysd comment...
-
4
conflict-marker.vim Highlight, jump and resolve conflict markers quickly. conflict-marker.vim is Vim plugin for developers fighting against conflicts. All features are...
About Joyk
Aggregate valuable and interesting links.
Joyk means Joy of geeK