@citedrive/bibtex-editor/README.md

CiteDrive BibTeX Editor

# CiteDrive BibTeX Editor

This repo holds CiteDrive's BibTeX-focused implementation of the CodeMirror editor. CiteDrive's full BibTeX Studio can be found on our [website](https://citedrive.com), and more details on the development of this editor can be found in this [blog post](https://citedrive.com/en/blog/codemirror-bibtex-plugin).

## Usage

Getting up and running is fairly straight-forward, the only dependencies are a working NodeJS installation and a web browser.

```bash
# clone the repo
git clone https://github.com/citedrive/bibtex-editor

# change directory
cd bibtex-editor

# install node dependencies
npm install

# run development server
npm run dev
```

If you are a Nix user, we have provided a flake with both a fully configured [devshell](https://github.com/numtide/devshell) and a package to run a local editor instance in your browser:

```bash
# development environment
nix develop github:citedrive/bibtex-editor

# run local instance
nix run github:citedrive/bibtex-editor
```

## Demos

You can see the development environment getting set up with nix:

![Demo `asciinema` gif of development environment setup](./.github/assets/nix-run.gif)

And a short demo of the editor itself:

![Demo video of BibTeX Editor being used](./.github/assets/bibtex-editor.mp4)