diff options
| author | lishid <[email protected]> | 2020-10-26 12:15:09 -0400 |
|---|---|---|
| committer | lishid <[email protected]> | 2020-10-26 12:15:09 -0400 |
| commit | a577988baae71de319979290821cc3b3edb46e70 (patch) | |
| tree | 5721f3d4d997739f596d6a60d664eac9a0bd4597 /README.md | |
| parent | 245339d8e08567a490df8dd5c2d25014539a8f99 (diff) | |
| download | ai-pulse-obsidian-plugin-a577988baae71de319979290821cc3b3edb46e70.tar.gz ai-pulse-obsidian-plugin-a577988baae71de319979290821cc3b3edb46e70.zip | |
Update readme.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 21 |
1 files changed, 3 insertions, 18 deletions
@@ -17,21 +17,6 @@ The repo contains the latest plugin API (obsidian.d.ts) in Typescript Definition - Copy over `main.js`, `styles.css`, `manifest.json` to your vault `vault/.obsidian/plugins/plugin-id/`.
-### Plugin structure
-
-`manifest.json`
-
- - `id` the ID of your plugin.
- - `name` the display name of your plugin.
- - `description` the long description of your plugin.
- - `isDesktopOnly` whether your plugin uses NodeJS or Electron APIs.
- - `js` (optional) an alternative js entry point. Defaults to `main.js`
- - `css` (optional) a css file that should be injected. Defaults to `styles.css`
-
- `main.js`
-
- - This is the main entry point of your plugin.
- - Import any Obsidian API using `require('obsidian')`
- - Import NodeJS or Electron API using `require('fs')` or `require('electron')`
- - Must export a default class which extends `CustomPlugin`
-
\ No newline at end of file +### API Documentation
+
+See https://github.com/obsidianmd/obsidian-api
|