https://github.com/kkharji/lispdocs.nvim

https://clojuredocs.org examples and notes, instantly under your finger tips
https://github.com/kkharji/lispdocs.nvim

Last synced: 11 days ago
JSON representation

https://clojuredocs.org examples and notes, instantly under your finger tips

• Host: GitHub
• URL: https://github.com/kkharji/lispdocs.nvim
• Owner: kkharji
• License: unlicense
• Created: 2020-12-27T19:03:51.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2022-07-05T07:48:54.000Z (almost 2 years ago)
• Last Synced: 2024-04-24T04:16:03.794Z (2 months ago)
• Language: Lua
• Homepage:
• Size: 1.22 MB
• Stars: 44
• Watchers: 2
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-stars - kkharji/lispdocs.nvim - https://clojuredocs.org examples and notes, instantly under your finger tips (Lua)
• awesome-stars - kkharji/lispdocs.nvim - https://clojuredocs.org examples and notes, instantly under your finger tips (Lua)

README

        
# lispdocs.nvim

View community usage examples/notes from within your editor.

![](./docs/preview.gif)

## Installation

Note: This plugin will only work on neovim 0.5.

```vim

Plug 'olical/conjure'

Plug 'kkharji/sqlite.lua'

Plug 'kkharji/lispdocs.nvim' " its a filetype plugin so no need to do any extra work.

```

Mappings:

- `hh` open a float

- `hv` open vsplit

- `hs` open split

- `hn` open in the current window

- `hf` launch telescope symbol finder

- `h` launch telescope symbol finder

Options:

disable default mappings: `let g:lispdocs_mappings = 0`

## API

`lispdocs` functions takes a dict defining the following.

- `opts.display`: which display type to use, "vsplit", "float", "split". o

- `opts.win`: float options (look at vim.w), most notably `winhl` which the background highlighting and `winblend` for transparency

- `opts.symbol`: The symbol to search for.

- `opts.fill`: How much the float window should cover, default 80% or as the option expect `0.8` .

- `opts.border`: the float window chars, see default `["─" "│" "╭" "╮" "╰" "╯"]`.

- `opts.buf`: buffer specific options, applies to all display types, (see vim.bo).

Examples:

```vim

nnoremap  :lua require'lispdocs'.float{ fill = 0.5, win = { winblend = 0, :cursorline false }}

nnoremap clojure :lua require'lispdocs'.split{ buf = {ft = "clojure"}} " bad idea

```

## Someday

- [X] Create a fuzzy finder with telescope.nvim

- [ ] Enable navigation between symbol docs through `See Also` section.

- [ ] Print to conjure float buffer if a symbol is not found

- [ ] support ClojureScript

- [ ] support hy

- [ ] support janet