Skip to main content

A simple LSP server for your bibliographies

Project description

Bibli Language Server

A Language Server that brings bibliographies into your note-taking workflows.

image-version image-license image-python-versions

Current features

  • Configuration file (see Configuration).
  • Autocompletion based on citation key.
  • LSP hover shows selected fields from your bibliography files.

Planned Features

  • Universal: Works with any note format
  • Configurable: Per-workspace configuration files
  • Rich LSP features:
    • Auto-completion & hint
    • Goto definition
  • Per-document bibliographies
  • Telescope integration

Configuration

Create a configuration file .bibli.toml at the root of your note directory. Here is a sample configurations:

bibfiles = ["references.bib"] # Relative path to your bibliographies

[hover]
show_fields = ["abstract", "year", "booktitle"]
format = "list" # Available formats: "markdown" and "list" (markdown-flavored list)

[completion]
cite_prefix = "@"

Installation

Install the latest release of bibli-ls through pip:

pip install bibli-ls

Neovim

Automatic configuration through lspconfig is not supported yet. Put the following code in your Neovim config to enable bibli-ls.

local lspconfig = require("lspconfig")
local configs = require("lspconfig.configs")

if not configs.bibli_ls then
 configs.bibli_ls = {
  default_config = {
   cmd = { "bibli_ls" },
   filetypes = { "markdown" },
   root_dir = lspconfig.util.root_pattern(".bibli.toml"),
  },
 }
end

lspconfig.bibli_ls.setup({})

Progress

Feature Status
LSP Hover TODO
LSP Completion WIP
User configs WIP

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bibli_ls-0.1.0.tar.gz (6.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bibli_ls-0.1.0-py3-none-any.whl (7.6 kB view details)

Uploaded Python 3

File details

Details for the file bibli_ls-0.1.0.tar.gz.

File metadata

  • Download URL: bibli_ls-0.1.0.tar.gz
  • Upload date:
  • Size: 6.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.9.19

File hashes

Hashes for bibli_ls-0.1.0.tar.gz
Algorithm Hash digest
SHA256 557731517cdf8f2fa433bebb7ac7422cc69c27f749170098714554c906672d03
MD5 6f64367a5809d1a697a6e52dca4c91e4
BLAKE2b-256 edcb0036172e02cd8004f0d2a1b9c1fbf9adb5f233a61b764c329c24584a35f6

See more details on using hashes here.

File details

Details for the file bibli_ls-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: bibli_ls-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 7.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.9.19

File hashes

Hashes for bibli_ls-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2cc77c4c10fe4912b7104573a5251a9eda15054d31bf0857fe836e36fe46dde9
MD5 9a76a015ff37fecbf5cd22d099e8f0d1
BLAKE2b-256 dcc994234124c89db4b75286fa2a22743151fc735f66dee4886430c173738786

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page