vschroeter / obsidian-virtual-linker

Plugin for obsidian that automatically generates virtual links for text within your notes that match with the titles or aliases of other notes in your vault.
Other
134 stars 5 forks source link

Buy Me a Coffee PayPal

Obsidian Virtual Linker Plugin (Glossary Plugin)

This plugin automatically generates virtual links for text within your notes that match with the titles or aliases of other notes in your vault.

Features:

Usage demo (literally just typing text ;-): Demo

Usage

By default, the plugin will automatically link all notes of your vault. All occurrences of a note title or alias will be linked in your current note text. If you only want to include notes of a specific folder, you can define this folder in the settings.

[!Note] The auto generated links are post-processed, so they neither change your note text to hard-coded links enclosed in brackets not appear in the graph view or reference counting.

Installing the plugin

Inside obsidian, you can search for "Virtual Linker" in the community plugins tab. After installing, enable the plugin in the settings.

To manually install the plugin:

Settings

Matched files

You can toggle the matching of files between:

Furthermore, you can explicitly include or exclude specific files from being matched, by adding a tag to the file. You can change the tag in the settings, by default it is:

You can also exclude all files in a specific folder by adding the folder to the exclude list in the settings.

[!Note] To include / exclude a file or folder, you can use the context menu on virtual links or in the file explorer.

Case sensitivity

You can toggle the case sensitivity of the matching. By default, the matching is case insensitive.

Often there are words with mainly capitalized letters, that should be matched case sensitive. By default, words with 75% or more capitalized letters are matched case sensitive. You can change this threshold in the settings.

You can also explicitly change the case sensitivity of a specific file by adding a tag to the file. You can change the tag in the settings, by default it is:

If you want to define the case sensitivity for specific aliases, you can define the frontmatter property lists in a note:

Matching mode

Suppress multiple matching and matching to real links

By default, the plugin will suppress several identical virtual link in the same note. Furthermore, you can toggle to suppress the creation of virtual links to files, that are linked by real links in the current note.

Part matching

You can toggle the matching mode between:

You furthermore have the option to suppress the link suffix for these matches to avoid cluttering your text.

Links to the note itself

By default, links to a note itself are suppressed. This link suppression might be a bit buggy and not work in all cases, e.g. in preview windows. If you like self-links to the note itself, you can toggle this behavior in the settings.

Link suppression in current line

By default, links are created directly as you type. You can disable links for the current line you are typing.

[!Note] Deactivating the link creation for the current line is recommended when using the plugin with IME (input method editor) for languages like Chinese or Japanese, as the plugin might otherwise interfere with the IME.

Styling of the links

Any created virtual link will be appended with this suffix. This is useful to distinguish between real and virtual links. By default, the suffix is "🔗".

By default (and if the default styling is toggled on in the settings), the links appear a little bit darker than your normal links. You can turn off this default styling in the settings.

To apply custom styling to the links, you can add a CSS-snippet at VaultFolder/.obsidian/snippets/virtualLinks.css file.

/* Properties of the virtual link when not hovered */
.virtual-link.glossary-entry a {
    /* To have the normal text color when not hovered */
    color: inherit;

    /* Or add a color, e.g. red */
    /* color: red; */

    /* You can also change the underline of the link in thickness, color, and other properties */
    text-decoration-thickness: 1px;
    text-decoration-color: rgb(var(--color-purple-rgb), 0.6);
    text-underline-position: under;
    /* text-decoration-style: dotted; */
    /* text-underline-offset: 0em; */
}

/* Properties of the virtual link when hovered */
.virtual-link.glossary-entry a:hover {
    color: var(--link-color);
}

[!Note] If you want to apply custom styling, don't forget to turn off the "Apply default link styling" in the settings.

How to use for development

It is recommended to use the Hot Reload Plugin for development.