https://github.com/unfoldingword-dev/obsidian-uw-rc-link-opener
Opens RC links locally in a Obsidian vault
https://github.com/unfoldingword-dev/obsidian-uw-rc-link-opener
Last synced: 2 months ago
JSON representation
Opens RC links locally in a Obsidian vault
- Host: GitHub
- URL: https://github.com/unfoldingword-dev/obsidian-uw-rc-link-opener
- Owner: unfoldingWord-dev
- License: mit
- Created: 2021-06-04T20:57:48.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-06-08T17:40:36.000Z (about 5 years ago)
- Last Synced: 2025-12-26T07:47:58.209Z (6 months ago)
- Language: TypeScript
- Size: 15.6 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Obsidian uW RC Link Opener
This is a plugin for Obsidian (https://obsidian.md).
Opens the file locally that an RC links in a Markdown file refers to, creating it if it doesn't exist
This project uses Typescript to provide type checking and documentation.
The repo depends on the latest plugin API (obsidian.d.ts) in Typescript Definition format, which contains TSDoc comments describing what it does.
This plugin does the following:
Takes a Markdown link like `[God](rc://en/tw/dict/bible/kt/god)` and finds that locally in the same valud as en_tw/bible/kt/god.md
### Using this plugin
To use:
- Clone your repo to your Obsidian vault's `.obsidian/plugins` directory (create if doesn't exist). Should result in a subdirectory with the path of `/.obsidian/plugins/obsidian-uw-rc-link-opener`.
- Install NodeJS, then run `npm i` in the command line under your repo folder.
- Run `npm run build` to compile this plugin from `main.ts` to `main.js`.
- If you want to develop and see you changes get compiled in real-time, run `npm run dev`