BookNav

BookNav Plugin

This is a plugin to create clickable internal or external links in a note (usually at the bottom) to guide a reader along an intended path. There are no dependencies on any other plugins. If the note is viewed in another application, it will be shown as a code block.

Why?

I found myself writing documentation for a number of processes. The documentation won't always be read by someone who understands Markdown, who uses Obsidian, or who will know where to find the documents. I have hosted web based documentation on local servers, but found those to be very limiting, costing money to host or license, or dealing with restrictions from IT blocking certain locations from access. It was much easier to share a vault with users (including configurations) and let them just use it.

I prefer the "book" style navigation when reading tutorials and found that most of the people I share my notes with did too. I was getting tired of typing raw HTML into the notes. Readers who liked to contribute also couldn't be bothered to learn HTML in the specific way to recreate the navigation links, so I made it easier (I hope).

Installation

Community Plugin

1. Search for "BookNav" in Obsidian's Community Plugins page
2. Install & Enable

Manual Plugin

1. Download release files (main.js, manifest.json, style.css)
2. Copy files into /path_to_your_vault/.obsidian/plugins/booknav/
3. Open Obsidian and goto Community Plugins page
4. Scroll down to the installed plugins (you may need to refresh)
5. Enable BookNav plugin by toggling the switch

Usage

Add a code block with the language "booknav". Each line of the code block will be parsed as a link. Styling is applied to links marked with "prev", "center", or "next".

```booknav
  [[Page One | prev]]
  [[Page Three | next]]
```

This will generate a full-width element on the note where the codeblock is placed. All links will be parsed and resolved to internal/external links. If the links are internal, the hover action will show the page preview.

Alternate text can be used with the links the way Obsidian normally processes the links. For example:

```booknav
  [[Page One | Alt Text for Page 1 | prev]]
  [[Page Three | Alt Text for Page 3 | next]]
```

This will render the previous and next page links with the text "Alt Text for Page 1" instead of "Page One" and "Alt Text for Page 3" instead of "Page Three". The regex expression used to parse out the "prev" and "next" will allow for the use of the | character in your alternate text. Something like:

```booknav
  [[Page One | Demo Page | A short description | prev]]
  [[Page Three | Alt Text for Page 3 | next]]
```

The rendered text for the previous page link will then be "Demo Page | A short description". The "prev" and "next" must be the last "alt" text for the link or the plugin will not catch it properly.

Styling

The default CSS included with the plugin uses color variables from the Obsidian namespace, so it should match the existing theme. You can customize the styling by adding a snippet and changing the following classes.

[!note] It may be necessary to mark the styling in your snippet with !important to take hold.

Configuration & Settings

There is nothing (at the time) to configure, so the plugin has no settings page.

[!note] There are potential plans to add configurable styling for colors, custom icons, and custom pseudo-element text.