Note: there is currently no update mechanism other than git pull origin main to update the code and thor docs:download -installed to download the latest version of the docs. To download and install all documentation this project has available, run thor docs:download -all. To update all downloaded documentations, run thor docs:download -installed. You can see the list of available documentations and versions by running thor docs:list. The thor docs:download command is used to download pre-generated documentations from DevDocs's servers (e.g. Once you have these installed, run the following commands:įinally, point your browser at localhost:9292 (the first request will take a few seconds to compile the assets). It's up-to-date and works offline out-of-the-box.ĭevDocs is made of two pieces: a Ruby scraper that generates the documentation and metadata, and a JavaScript app powered by a small Sinatra app.ĭevDocs requires Ruby 2.7.4, libcurl, and a JavaScript runtime supported by ExecJS (included in OS X and Windows Node.js on Linux). Unless you wish to contribute to the project, we recommend using the hosted version at devdocs.io. Please reach out to the community on Discord if you would like to join the team! We are currently searching for maintainers THE USE OR OTHER DEALINGS IN THE SOFTWARE.DevDocs combines multiple developer documentations in a clean and organized web UI with instant search, offline support, mobile version, dark theme, keyboard shortcuts, and more.ĭevDocs was created by Thibaut Courouble and is operated by freeCodeCamp. TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, The above copyright notice and this permission notice shall be included in allĬopies or substantial portions of the Software. Of the Software, and to permit persons to whom the Software is furnished to do so, To use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies In the Software without restriction, including without limitation the rights Of this software and associated documentation files (the "Software"), to deal Permission is hereby granted, free of charge, to any person obtaining a copy " 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 Want to use non-default browser, please use g:devdocs_open_cmd to specify what command should be If you don't install open-browser.vim and If it is not installed, it tries to open default browser. You can use devdocs#open_doc() function to make such a command.īelow is an example for :DevDocsReact command to open page with 'react' documentation command ! -nargs =* DevDocsReact call devdocs#open_doc (, 'react' )ĭevdocs.vim opens URL with open-browser.vim at first. let g:devdocs_url = ' Make a command for specific document If you use to host your DevDocs instance, please use g:devdocs_url variable to specifyĪn scheme. If your localĭevdocs is hosted at localhost:9292, devdocs.vim uses it by following configuration. let g:devdocs_filetype_map = Open local devdocs You can customize relationship between Vim's filetype and documentation.īelow is an example of customization. Open with specific documentation on specific filetype If you want to override K mapping in specific filetypes, augroup plugin-devdocsĪutocmd FileType c,cpp,rust,haskell,python nmap K (devdocs-under-cursor)Ībove replaces K in C, C++, Rust, Haskell, and Python. If you always want to override K mapping, nmap K (devdocs -under -cursor ) You should define key mappings if you need. :DevDocsAll : Search with query with all documentation ( query can be omitted)Ĭustomize Mapping K to search under the word quicklyĭevdocs.vim doesn't overrides any mapping by default.:DevDocs : Search with query with filetype related documentation ( query can be omitted). Relate filetype to specific documentation.Open and search devdocs using command :DevDocs or :DevDocsAll.You can open and search devdocs from Vim. This is a Vim plugin for devdocs, which is an awesome multiple API documentation
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |