https://github.com/coddingtonbear/obsidian-local-rest-api-sample-api-extension

An example plugin demonstrating how you can add additional routes to Obsidian Local REST API
https://github.com/coddingtonbear/obsidian-local-rest-api-sample-api-extension

Last synced: 2 months ago
JSON representation

An example plugin demonstrating how you can add additional routes to Obsidian Local REST API

• Host: GitHub
• URL: https://github.com/coddingtonbear/obsidian-local-rest-api-sample-api-extension
• Owner: coddingtonbear
• License: mit
• Created: 2024-07-31T00:15:28.000Z (5 months ago)
• Default Branch: master
• Last Pushed: 2024-08-03T15:55:51.000Z (5 months ago)
• Last Synced: 2024-10-03T08:17:22.818Z (3 months ago)
• Language: TypeScript
• Size: 39.1 KB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Obsidian Local REST API Sample Plugin

This plugin provides an example of how you might add additional plugins to

Obsidian Local REST API.

## Instructions

1. Fork this repository.

2. Update `main.ts` to advertise your new route(s).

3. Build the project with `npm run build` (or `npm run dev` if you are iterating on some changes).

4. Link the plugin into your Obsidian vault's `.obsidian/plugins` directory.  On linux or osx, you can run `ln -s /path/to/your/cloned/fork /path/to/your/vault/.obsidian/plugins`.

5. Enable the plugin in Obsidian's Community Plugins settings page.