Code Monkey home page Code Monkey logo

obsidian-alias-manager's Introduction

Obsidian Alias Manager

Obsidian Alias Manager (OAM) is a plugin for managing note aliases for notes in Obsidian categoried with the Johnny Decimal system.

Installation

This plugin isn't released yet, so installation isn't officially supported. If you're a developer working on Obsidian plugins, you'll know how to install this!

Usage

OAM will add a non-indexed alias to your note, allowing you to link to it in other notes naturally, without the index number as part of the title. The note in the below screenshot has the filename 40.00 Tornados, as per Johnny Decimal convention. This plugin automatically adds the relevant YAML frontmatter and manages the alias Tornados, which is based on removing the Johnny Decimal index 40.00:

Example image

OAM will automatically run when a new file is created, and when your Obsidian application is initialized. If you'd like to run it manually, you can open the Command Palette (CMD+P on Mac, Ctrl+P on Windows), and run the "Update Aliases" command.

Developer warning

This plugin is not yet released or officially supported by the author. It can break your notes. Make backups!

The YAML frontmatter aspect of this plugin is weird. Obsidian doesn't expose any sort of official API for managing frontmatter, so this plugin parses the Markdown content for a note, and rewrites the YAML as part of rewriting the file content. That means all of the content in a note is parsed and rewritten back into the file, if the plugin determines that a new alias needs to be added. This plugin is working for my Obsidian vault, but I'm pretty new to the application, and there may be things you do in your vaults (or that plugins that you use do) that I haven't tested. Be careful!

Known issues

  • OAM may not run automatically on updates to notes. Manually running the "Update Aliases" command should fix this.
  • OAM may have issues initializing while running through npm run dev (development workflow). Kill the process and run npm run dev again, which should fix it.
  • The ability to set custom index patterns via the plugin settings page has not been tested, careful!

obsidian-alias-manager's People

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.