commit dfd3fe233b6a7cf4bfe11d0644426fd09c381dd7 parent ed3770792a7a9ce698999de42ebb6150f5ee5e9e Author: lishid <lishid@gmail.com> Date: Sun, 25 Oct 2020 17:21:52 -0400 Update documentation. Diffstat:
| M | README.md | | | 18 | +++++++++++++----- |
1 file changed, 13 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md @@ -1,21 +1,29 @@ -### Obsidian Sample Plugin +## 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 JSDoc comments describing what it does. +The repo contains the latest plugin API (obsidian.d.ts) in Typescript Definition format, which contains TSDoc comments describing what it does. -#### How to use +**Note:** The Obsidian API is still in early alpha and is subject to change at any time! + +### Compatibility + +Custom plugins are only available for Obsidian v0.9.7+. + +The current API of this repo targets Obsidian **v0.9.7**. + +### 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 +### How to install the plugin - Copy over `main.js`, `styles.css`, `manifest.json` to your vault `vault/.obsidian/plugins/plugin-id/`. -#### Plugin structure +### Plugin structure `manifest.json`