Skip to content
This repository has been archived by the owner on Jan 24, 2022. It is now read-only.
/ elf Public archive

A simple Obsidian plugin that incorporates limited Reading View functionality into Live Preview mode.

License

Notifications You must be signed in to change notification settings

mirnovov/elf

Repository files navigation

This plugin has been archived as much of its functionality is being implemented in base Obsidian. For more information, see here.

ELF - Enhanced Live Preview

Incorporates limited Reading View functionality into Obsidian's Live Preview mode, allowing you to use it for both reading and editing.


Currently, behavior supported in Live Preview includes:

  • Some link interactions (including clicking without holding down Ctrl/Cmd). Links can still be edited when the cursor is within their bounds.
  • Minor rendering changes to appear visually closer to Reading mode.
  • Unfocusing on note open. This also includes deselecting text where possible so it doesn't show the Markdown syntax.

This plugin is somewhat experimental - due to the workarounds that are used to make this plugin function, maximum compatibilty is not guaranteed. Nevertheless, if you experience problems, please report it as an issue.

Installation

The easiest way to install ELF is to use Obsidian's built-in plugin browser - or for pre-release versions, a tool such as BRAT.

But if you've a developer, you can install it manually: download the directory and initialise sources using npm install. Once installed, you can get ESBuild to rebuild the plugin every time you've changed something:

npm dev path/to/test/vault/.obsidian/plugins/elf/main.js

You can also run npm run build to create production sources in an ./out folder. These can then be copied to path/to/vault/.obsidian/plugins/elf in your vault to use as a plugin.

About

A simple Obsidian plugin that incorporates limited Reading View functionality into Live Preview mode.

Topics

Resources

License

Stars

Watchers

Forks