https://github.com/oncomouse/citation-langserver

https://github.com/oncomouse/citation-langserver

Last synced: 12 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/oncomouse/citation-langserver
• Owner: oncomouse
• License: mit
• Created: 2020-09-12T15:49:01.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2021-04-29T14:32:04.000Z (about 5 years ago)
• Last Synced: 2024-04-24T16:19:28.569Z (about 2 years ago)
• Language: Python
• Size: 86.9 KB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Citation: citation_langserver/__init__.py

Awesome Lists containing this project

README

          
# citation-langserver

citation-langserver is a language server for working with citations stored in BibTeX or BibLaTeX files.

citation-langserver supports code completion, hover, jump to definition, and find references. It supports absolute file paths for bibliographies, relative file paths, as well as glob-based file paths. It is compatible with all clients that support the [Language Server Protocol](https://langserver.org/)

# Installation

Run `pip3 install citation-langserver` to install.

# Usage

Configure `citation-langserver` as you would any other LSP in your text editor of choice.

For instance, using [CoC](https://github.com/neoclide/coc.nvim) in Vim, you might add the following to your `coc-settings.json` file:

```json

  "languageserver": {

    "citation": {

      "command": "/usr/local/bin/citation-langserver",

      "filetypes": ["markdown"],

      "settings": {

        "citation": {

          "bibliographies": [

            "~/library.bib",

			"./*.bib"

          ]

        }

      }

    }

  }

```

## Configuration

The setting `citation.bibliographies` needs to be sent by the client to the server and contain an array of file paths. The file paths can include:

- Absolute paths

- Relative paths

- Globs (absolute or relative)