telescope-bibtex

Search and paste entries from *.bib files with telescope.nvim.

The *.bib files must be under the current working directory or you need to supply global files/directories (see Configuration).

Requirements

telescope.nvim

Installation

Plug

Plug 'nvim-telescope/telescope-bibtex.nvim'

Usage

lua require"telescope".load_extension("bibtex")

:Telescope bibtex

Keybindings (Actions)

key	Usage
<cr>	Insert the citation label
<c-e>	Insert the citation entry

Configuration

The default search depth for *.bib files is 1.

The currently supported formats are:

Identifier	Result
tex	\cite{label}
markdown	@label
plain	label

You may add custom formats: id is the format identifier, cite_marker the format to apply.

Some people have master *.bib files that do not lie within the project tree. Directories and files to retrieve entries from can be set.

The default search matches author, year, title in this order.

To search for the citation label, add label to the search_keys. Other keys to match are named by their tag in the bibtex file.

See the example below for the config in action:

require"telescope".setup {
  ...

  extensions = {
    bibtex = {
      depth = 1,
      custom_formats = {
        {id = 'myCoolFormat', cite_marker = '#%s#'}
      },
      format = 'myCoolFormat',
      global_files = { 'path/to/my/bib/file.bib', 'path/to/my/bib/directory' },
      search_keys = { 'label', 'author', 'publisher' },
    },
  }
}

This produces output like #label#.

The entry action will always paste the whole entry.

Think of this as defining text before and after the entry and putting a %s where the entry should be put.

If format is not defined, the plugin will try to find the right format based on the filetype. If there is no format for the filetype it will fall back to plain format.

To quickly change the format, you can specify it via the options:

:Telescope bibtex format=markdown

Troubleshooting

If the config does not seem to work/apply, check at which point you load the extension. The extension will only be initialized with the right config if it is loaded after calling the setup function.