English | 中文

Obsidian Sample Plugin

This is a sample plugin for Obsidian (https://obsidian.md).

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.

Installation

Community plugin market installation

Click to install, or:

1. Open Obsidian and go to Settings > Community Plugins.
2. Search for "Obsidian Plugin Starter".
3. Click "Install".

BRAT (Recommended for Beta Users)

1. Install BRAT plugin
2. Click "Add Beta plugin" in BRAT settings
3. Enter Raven-Pensieve/obsidian-plugin-starter
4. Enable the plugin

License

This project is licensed under the xxx LICENSE - see the LICENSE file for details.

Star History