swarnam-obsidian/README.md

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 contains the latest plugin API (obsidian.d.ts) in Typescript Definition format, which contains TSDoc comments describing what it does.

Note: The Obsidian API is still in early alpha and is subject to change at any time!

How to use

• Clone this repo.
• npm i or yarn to install dependencies
• npm run dev to start compilation in watch mode.

How to install the plugin

• Copy over main.js, styles.css, manifest.json to your vault vault/.obsidian/plugins/plugin-id/.

API Documentation

See https://github.com/obsidianmd/obsidian-api