Skip to content

An Inkdrop plugin to insert your cite database as Markdown references/bibliography.

License

Notifications You must be signed in to change notification settings

alvgaona/inkdrop-citations

Repository files navigation

citations

This plugin allows to easily manage your references in the Markdown files.

Features

  • Paste any citation database and automatically append it in the Markdown file.
  • Supports multiple database formats, e.g., BibTeX, BibJSON, CSL-JSON, RIS.
  • Preview multiple citation formats, e.g., APA, Vancouver, Harvard.
  • Count references and cites.

Install

ipm install citations

Usage

There are only so many commands to use this plugin.

  1. You can preview the supported input and output formats.

    Preview

  2. It is possible to append references by pasting the bibliography database content into the textbox, choosing the header text and the output format.

    Add

  3. Last and not least, you have the possibiity to count number of references.

    Count

Keyboard Shortcuts

  • Ctrl+Alt A or ⌃⌥A: Append references.
  • Ctrl+Alt P or ⌃⌥P: Preview formats.
  • Ctrl+Alt C or ⌃⌥C: Count references.
  • Ctrl+Alt H or ⌃⌥H: Help dialog.

Tips & Tricks

  1. After you add your references you will find that each reference has a unique id of the form citations-<randomId>. Then, you'd need to use this id in any of the links within your article by doing [1](#citations-Mw3R). This will render a link so when you click it, it'll redirect you to the corresponding reference.

License

Licensed under the MIT License.

About

An Inkdrop plugin to insert your cite database as Markdown references/bibliography.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks