Thanks to visit codestin.com
Credit goes to github.com

Skip to content

jalvesaq/zotcite

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Zotcite

Note

Users of Vim and Neovim < 0.10.4 have to switch to the "vim" branch.

Note

Users of Neovim < 0.11.5 have to switch to the "pynvim" branch.

Note

Zotcite now uses conventional citation keys based on a citation template and no longer requires the zotref filter. Alternatively, it can use Better BibTeX citation keys. There is also an option to use the internal Zotero item keys and insert the "Author-Year" part of the citation key as virtual text. If you have documents using the old system, and don't want to manually convert then, you can use the "pynvim" branch.

Zotcite is a Neovim plugin that provides integration with Zotero for Markdown, Quarto, Rmd, vimwiki, Typst, LaTeX, and Rnoweb file types. With zotcite you can:

  • Do auto-completion of citation keys from Zotero database in Markdown, RMarkdown, Quarto, LaTeX, Rnoweb, and Typst documents.

  • Quickly see on the status bar information on the reference under the cursor.

  • Open the PDF attachment of the reference associated with the citation key under the cursor.

  • Extract notes and highlighted text from PDF attachments of references.

  • Extract Zotero notes and annotations from Zotero database.

Installation

Dependencies

  • Required:

    • Zotero >= 5

    • The sqlite3 command line application.

    • nvim-treesitter as well as tree-sitter parsers for markdown, markdown_inline, and yaml. If editing LaTeX, Rnoweb, or Typst files, you will also need their parsers.

  • Optional:

    • telescope.nvim for an alternative way of inserting citation keys.

    • Python 3 is required if you are going to convert OpenDocument texts (odt) to markdown or extract annotations inserted in a PDF document by a PDF viewer other than Zotero. Please, see the Zotcite documentation for details.

Zotcite can be installed as any Neovim plugin. Below is an example of how to install zotcite with lazy.nvim:

    {
        "jalvesaq/zotcite",
        dependencies = {
            "nvim-treesitter/nvim-treesitter",
            "nvim-telescope/telescope.nvim",
        },
        config = function ()
            require("zotcite").setup({
                -- your options here (see doc/zotcite.txt)
            })
        end
    },

Note

You don't need to lazy load zotcite because it is a filetype plugin. This means that it already lazy loads its modules, which will be enabled only for the supported file types.

Usage

Please, read the plugin's documentation for further instructions.

Screenshots

See the Wiki

See also:

Zotcite's original Python code was based on the citation.vim project.

Similar project: telescope-zotero.nvim

About

Neovim plugin for integration with Zotero

Topics

Resources

License

Stars

Watchers

Forks

Contributors 12