telescope-heading.nvim

An extension for telescope.nvim that allows you to switch between document's headings.

Supported File Types

| File Type | Tree-sitter | Notes | | ---------------- | ----------- | -------------------------------------------------------------- | | AsciiDoc | ✅ | | | Beancount | ✅ | | | LaTeX | ⬜ | | | Markdown | ✅ | including vimwiki, vim-pandoc-syntax, and vim-gfm-syntax | | Neorg | ✅ | | | OrgMode | ⬜ | | | ReStructuredText | ✅ | | | Vimdoc (help) | ✅ | |

Setup

Install with your favorite package manager:

use('nvim-telescope/telescope.nvim')
use('crispgm/telescope-heading.nvim')

You can setup the extension by adding the following to your config:

require('telescope').load_extension('heading')

Tree-sitter Support

telescope-heading supports Tree-sitter for parsing documents and finding headings. But not all file types are supported, you may check Supported File Types section and inspect the Tree-sitter column.

-- add nvim-treesitter use('nvim-treesitter/nvim-treesitter')

-- make sure you have already installed treesitter modules require('nvim-treesitter.configs').setup({     ensure_installed = {         -- ..         'markdown',         'rst',         -- ..     }, })
-- enable treesitter parsing local telescope = require('telescope') telescope.setup({     -- ...     extensions = {         heading = {             treesitter = true,         },     }, })
-- load_extension must be after telescope.setup telescope.load_extension('heading')

If nvim-treesitter was not correctly loaded, it would have fallen back to normal parsing. You may check nvim-treesitter configurations and whether your language is TSInstalled.

Telescope Picker Options

We may specific picker options for telescope-heading, which overrides the general telescope picker options.

local telescope = require('telescope')
telescope.setup({
    -- ...
    extensions = {
        heading = {
          picker_opts = {
              layoutconfig = { width = 0.8, previewwidth = 0.5 },
              layout_strategy = 'horizontal',
          },
        },
        -- ...
    },
})

Usage

:Telescope heading

Development

Init:

make init

Load telescope-heading locally:

nvim --noplugin -u scripts/minimal_init.vim ./README.md # replace with /path/to/testfile
or
make test

Lint:

make lint

Contributing

All contributions are welcome.

License

Copyright 2023 David Zhang. MIT License.