Plugin icon

Bidirectional Links


Create bidirectional to other notes

Additional Information

Maintainers: benlau
Minimum app version:1.8.1
Downloads: This version:1265
Last updated:2023-06-24T16:07:18Z

Bidirectional Links Plugin for Joplin

This plugin is designed for Joplin, a note-taking app, and allows users to easily create bidirectional links between notes. This project is a fork of the Quick Links Plugin project.

Please note that this plugin is currently only supported in the Markdown editor and is not compatible with the WYSIWYG editor.

How to use

To create a bidirectional link between notes, simply type ||| anywhere within your note and select the desired note from the dropdown menu. This will insert a link to the selected note at the current cursor position, as well as append a link to the current note within the target note, thereby creating a bidirectional link.

How to install

From Joplin desktop open Options - Plugins, search for "bidirectional links" and install.

Developing on the plugin

The main two files you will want to look at are:

  • /src/index.ts, which contains the entry point for the plugin source code.
  • /src/manifest.json, which is the plugin manifest. It contains information such as the plugin a name, version, etc.

Building the plugin

The plugin is built using Webpack, which creates the compiled code in /dist. A JPL archive will also be created at the root, which can use to distribute the plugin.

To build the plugin, simply run npm run dist.

The project is setup to use TypeScript, although you can change the configuration to use plain JavaScript.

Updating the plugin framework

To update the plugin framework, run npm run update.

In general this command tries to do the right thing - in particular it's going to merge the changes in package.json and .gitignore instead of overwriting. It will also leave "/src" as well as untouched.

The file that may cause problem is "webpack.config.js" because it's going to be overwritten. For that reason, if you want to change it, consider creating a separate JavaScript file and include it in webpack.config.js. That way, when you update, you only have to restore the line that include your file.