diff options
| author | lishid <[email protected]> | 2020-10-25 16:55:59 -0400 |
|---|---|---|
| committer | lishid <[email protected]> | 2020-10-25 16:58:31 -0400 |
| commit | ed3770792a7a9ce698999de42ebb6150f5ee5e9e (patch) | |
| tree | 0a7e047f2806eaccc88247d8ab360d6b877fa063 /README.md | |
| download | ai-pulse-obsidian-plugin-ed3770792a7a9ce698999de42ebb6150f5ee5e9e.tar.gz ai-pulse-obsidian-plugin-ed3770792a7a9ce698999de42ebb6150f5ee5e9e.zip | |
Initial commit!
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..8adca48 --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +### 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.
+
+#### 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
+
+- 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 |