README file from
GithubLiteCite
A lightweight Obsidian plugin that creates citation notes from a BibTeX / BibLaTeX file.
While this plugin might seem like a "re-invention of the wheel" for the Citations plugin, it is no longer actively maintained. I've developed this new plugin to be lighter, simpler, and faster.
It leverages Eta as its templating engine and uses a custom-built parser for BibTeX entries.
This plugin is based on the ras0q/obsidian-plugin-deno-template template.
Usage
- Install and enable the plugin
- Open the plugin settings and set the path to your BibTeX file
- Use the command
LiteCite: Create note from BibTeXto create a new note from a BibTeX entry
Development
- Install Deno
- Run
deno task dev, which will:- Clone the sample vault to
./vault-for-my-feature - Build the plugin with live reload
- Clone the sample vault to
- Open the sample vault in Obsidian
- Enable the plugin in Obsidian settings
IDE Integration
VSCode
{
"[css]": {
"editor.defaultFormatter": "denoland.vscode-deno"
},
"[json]": {
"editor.defaultFormatter": "denoland.vscode-deno"
},
"[jsonc]": {
"editor.defaultFormatter": "denoland.vscode-deno"
},
"[markdown]": {
"editor.defaultFormatter": "denoland.vscode-deno"
},
"[typescript]": {
"editor.defaultFormatter": "denoland.vscode-deno"
},
"[yaml]": {
"editor.defaultFormatter": "denoland.vscode-deno"
},
"deno.enable": true,
"deno.lint": true,
}
Release
- Update the version in
manifest.json - Run
deno task build, which will:- Build the plugin to
./dist
- Build the plugin to
- Commit and push the changes to GitHub
- Run
gh release create {{version}} ./dist/main.js ./dist/manifest.json ./dist/styles.css --generate-notes --draft --fail-on-no-commits