Bi-directional Links v2.9.0

Word count

441 words

Reading time

3 minutes

Bi-directional links (also known as internal links), and another concept you may know and hear about WikiLinks, holds a important place in the document engineering area. It is usually used to quickly establish a connection (or link) from one page to another page, and widely used in Wiki pages such as Wikipedia, and now days popular tools such as Obsidian and Logseq.

This plugin is a fully featured compatible implementation version of Obsidian's internal links, it follows two rules:

A page's file name (without extension) can be used as a link target, for example: [[Bi-directional Links Example Page]] will be parsed as a link to the globally unique Bi-directional Links Example Page.md file.
A link target can be an absolute path, for example: [[Some Folder/Bi-directional Links Example Page]] will be parsed as a link to Some Folder/Bi-directional Links Example Page.md, usually appears when you have multiple files with the same name.

Features

Basic syntax

Able to handle hash tags #

Able to handle query strings ?

Images

Custom text

Custom HTML attributes

Same name pages

Absolute path

How it looks like

Basic: Bi-directional Links Example Page

Custom text: Custom Text

Compatible to modify the HTML attributes Custom Attrs

Obsidian same name pages: Bi-directional Links Example Same Name Page 和 Bi-directional Links Example Same Name Page

Absolute Path: pages/en/integrations/markdown-it-bi-directional-links/Bi-directional Links Example Page

Images are supported:

Audio is not a concern either:

Video is even less of a problem:

Installation

It is easy and straightforward to install the Bi-directional links plugin into your VitePress project, please follow the steps under Getting started page!