Update readme.
This commit is contained in:
parent
245339d8e0
commit
a577988baa
1 changed files with 2 additions and 17 deletions
19
README.md
19
README.md
|
@ -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/`.
|
- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `vault/.obsidian/plugins/plugin-id/`.
|
||||||
|
|
||||||
### Plugin structure
|
### API Documentation
|
||||||
|
|
||||||
`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`
|
|
||||||
|
|
||||||
|
See https://github.com/obsidianmd/obsidian-api
|
||||||
|
|
Loading…
Reference in a new issue