Skip to content

Telescope extensions to read the docs right in your editor.

Notifications You must be signed in to change notification settings

devkvlt/telescope-docs

Repository files navigation

Telescope Docs

Telescope extensions to read the docs right in your editor.

There are currently 2 extensions available:

  • html_tags: MDN documentation for HTML tags.

  • godoc: Go documentation (currently limited to functions, methods and types.)

Select a tag to open its full documentation in your browser.

Install

For example, with packer.nvim:

use({
  'devkvlt/telescope-docs',
  requires = { 'nvim-telescope/telescope.nvim' },
})

Setup

require('telescope').load_extension('html_tags')
require('telescope').load_extension('godoc')

Usage

html_tags

html_tags_.mov
:Telescope html_tags

Or with Lua:

require('telescope').extensions.html_tags.html_tags()

godoc

godoc_funcs_.mov
:Telescope godoc funcs
:Telescope godoc methods
:Telescope godoc types

Or with Lua:

require('telescope').extensions.godoc.funcs()
require('telescope').extensions.godoc.methods()
require('telescope').extensions.godoc.types()