Skip to content

Commit a577988

Browse files
committed
Update readme.
1 parent 245339d commit a577988

File tree

1 file changed

+3
-18
lines changed

1 file changed

+3
-18
lines changed

README.md

Lines changed: 3 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -17,21 +17,6 @@ The repo contains the latest plugin API (obsidian.d.ts) in Typescript Definition
1717

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

20-
### Plugin structure
21-
22-
`manifest.json`
23-
24-
- `id` the ID of your plugin.
25-
- `name` the display name of your plugin.
26-
- `description` the long description of your plugin.
27-
- `isDesktopOnly` whether your plugin uses NodeJS or Electron APIs.
28-
- `js` (optional) an alternative js entry point. Defaults to `main.js`
29-
- `css` (optional) a css file that should be injected. Defaults to `styles.css`
30-
31-
`main.js`
32-
33-
- This is the main entry point of your plugin.
34-
- Import any Obsidian API using `require('obsidian')`
35-
- Import NodeJS or Electron API using `require('fs')` or `require('electron')`
36-
- Must export a default class which extends `CustomPlugin`
37-
20+
### API Documentation
21+
22+
See https://github.com/obsidianmd/obsidian-api

0 commit comments

Comments
 (0)