Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/davidgranstrom/telescope-scdoc.nvim
A SuperCollider documentation picker.
https://github.com/davidgranstrom/telescope-scdoc.nvim
lua neovim nvim telescope
Last synced: 3 months ago
JSON representation
A SuperCollider documentation picker.
- Host: GitHub
- URL: https://github.com/davidgranstrom/telescope-scdoc.nvim
- Owner: davidgranstrom
- License: mit
- Created: 2021-12-22T14:52:49.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-10T15:26:15.000Z (9 months ago)
- Last Synced: 2024-01-17T19:17:58.558Z (6 months ago)
- Topics: lua, neovim, nvim, telescope
- Language: Lua
- Homepage:
- Size: 11.7 KB
- Stars: 9
- Watchers: 4
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-supercollider - telescope-scdoc.nvim - Telescope help file plugin. (Editors / (Neo)Vim)
README
# telescope-scdoc.nvim
A SuperCollider documentation picker.
## Requirements
* scnvim
* telescope
## Installation
Install the plugin
```lua
use { 'davidgranstrom/telescope-scdoc.nvim' }
```
Load the extension *after* the call to `telescope.setup{}`
```lua
require'telescope'.load_extension('scdoc')
```
## Usage
**Note** scnvim needs to be started (`:SCNvimStart`) before you can browse the documentation.
Use the Telescope command.
```vim
:Telescope scdoc
```
Or call the function.
```vim
:lua require'telescope'.extensions.scdoc.scdoc()
```
## License
Same as Telescope.
```text
MIT License
Copyright (c) 2021 David Granström
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.
```