2020-10-25 17:21:52 -04:00
|
|
|
## Obsidian Sample Plugin
|
2020-10-25 16:55:59 -04:00
|
|
|
|
|
|
|
|
This is a sample plugin for Obsidian (https://obsidian.md).
|
|
|
|
|
|
|
|
|
|
This project uses Typescript to provide type checking and documentation.
|
2020-10-25 17:21:52 -04:00
|
|
|
The repo contains the latest plugin API (obsidian.d.ts) in Typescript Definition format, which contains TSDoc comments describing what it does.
|
2020-10-25 16:55:59 -04:00
|
|
|
|
2020-10-25 17:21:52 -04:00
|
|
|
**Note:** The Obsidian API is still in early alpha and is subject to change at any time!
|
|
|
|
|
|
|
|
|
|
### How to use
|
2020-10-25 16:55:59 -04:00
|
|
|
|
|
|
|
|
- Clone this repo.
|
|
|
|
|
- `npm i` or `yarn` to install dependencies
|
|
|
|
|
- `npm run dev` to start compilation in watch mode.
|
|
|
|
|
|
2020-10-25 17:21:52 -04:00
|
|
|
### How to install the plugin
|
2020-10-25 16:55:59 -04:00
|
|
|
|
|
|
|
|
- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `vault/.obsidian/plugins/plugin-id/`.
|
|
|
|
|
|
2020-10-26 12:15:09 -04:00
|
|
|
### API Documentation
|
|
|
|
|
|
|
|
|
|
See https://github.com/obsidianmd/obsidian-api
|
