{"id":13409511,"url":"https://github.com/amrbashir/nvim-docs-view","last_synced_at":"2025-04-05T00:07:22.509Z","repository":{"id":37242575,"uuid":"491954993","full_name":"amrbashir/nvim-docs-view","owner":"amrbashir","description":"A neovim plugin to display lsp hover documentation in a side panel.","archived":false,"fork":false,"pushed_at":"2025-03-24T07:36:56.000Z","size":528,"stargazers_count":157,"open_issues_count":0,"forks_count":5,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-28T18:54:25.831Z","etag":null,"topics":["neovim","neovim-plugin","nvim","nvim-lsp"],"latest_commit_sha":null,"homepage":"","language":"Lua","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/amrbashir.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-05-13T15:43:29.000Z","updated_at":"2025-03-27T18:55:34.000Z","dependencies_parsed_at":"2024-01-20T02:14:56.089Z","dependency_job_id":"2a0baf2d-1693-45d1-b60d-3a8d60336575","html_url":"https://github.com/amrbashir/nvim-docs-view","commit_stats":{"total_commits":29,"total_committers":5,"mean_commits":5.8,"dds":0.1724137931034483,"last_synced_commit":"365593534e0acd762bfddce6e8313315ffa4fa36"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amrbashir%2Fnvim-docs-view","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amrbashir%2Fnvim-docs-view/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amrbashir%2Fnvim-docs-view/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amrbashir%2Fnvim-docs-view/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/amrbashir","download_url":"https://codeload.github.com/amrbashir/nvim-docs-view/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247266563,"owners_count":20910836,"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":["neovim","neovim-plugin","nvim","nvim-lsp"],"created_at":"2024-07-30T20:01:01.528Z","updated_at":"2025-04-05T00:07:22.488Z","avatar_url":"https://github.com/amrbashir.png","language":"Lua","readme":"[![StandWithPalestine](https://raw.githubusercontent.com/Safouene1/support-palestine-banner/master/StandWithPalestine.svg)](https://techforpalestine.org/learn-more)\n\n# nvim-docs-view\n\nA neovim plugin to display lsp hover documentation in a side panel.\n\n\u003e Inspired by the VSCode extension [Docs View](https://marketplace.visualstudio.com/items?itemName=bierner.docs-view).\n\n\u003cimg alt=\"doc-view-example\" src=\"demo.gif\" width=\"500\" /\u003e\n\n## Installation\n\nUsing [packer.nvim](https://github.com/wbthomason/packer.nvim)\n\n```lua\nuse {\n  \"amrbashir/nvim-docs-view\",\n  opt = true,\n  cmd = { \"DocsViewToggle\" },\n  config = function()\n    require(\"docs-view\").setup {\n      position = \"right\",\n      width = 60,\n    }\n  end\n}\n```\n\nUsing [vim-plug](https://github.com/junegunn/vim-plug)\n\n```viml\nPlug 'amrbashir/nvim-docs-view', { 'on': 'DocsViewToggle'}\n\nlua \u003c\u003c EOF\n  require(\"docs-view\").setup {\n    position = \"right\",\n    width = 60,\n  }\nEOF\n```\n\nUsing [lazy.nvim](https://github.com/folke/lazy.nvim)\n```lua\n{\n  \"amrbashir/nvim-docs-view\",\n  lazy = true,\n  cmd = \"DocsViewToggle\",\n  opts = {\n    position = \"right\",\n    width = 60\n  }\n}\n```\n\n## Options\n\n- `position`:\n  - description: Determines where to open the docs view panel.\n  - type: `string`\n  - default: `right`\n  - possible: `right` | `left` | `top` | `bottom`\n- `height`:\n  - description: Height of the docs view panel when position is set to `top` or `bottom`\n  - type: `number`\n  - default: `10`\n- `width`:\n  - description: Width of the docs view panel when position is set to `right` or `left`\n  - type: `number`\n  - default: `60`\n- `update_mode`:\n  - description: Determines the mechanism used to update the docs view panel content. If `auto`, the content will update upon cursor move. If `manual`, the content will only update once `:DocsViewUpdate` is called.\n  - type: `string`\n  - default: `auto`\n  - possible: `auto` | `manual`\n\n## Commands\n\n- `:DocsViewToggle` to open/close the docs view panel.\n- `:DocsViewUpdate` to manually update the docs view panel (will open the docs view panel if necessary).\n\n## LICENSE\n\n[MIT](./LICENSE) © Amr Bashir\n","funding_links":[],"categories":["LSP","Lua"],"sub_categories":["(requires Neovim 0.5)"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Famrbashir%2Fnvim-docs-view","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Famrbashir%2Fnvim-docs-view","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Famrbashir%2Fnvim-docs-view/lists"}