2020-10-25 21:21:52 +00:00
## Obsidian Sample Plugin
2020-10-25 20:55:59 +00:00
This is a sample plugin for Obsidian (https://obsidian.md).
This project uses Typescript to provide type checking and documentation.
2020-10-29 00:48:24 +00:00
The repo depends on the latest plugin API (obsidian.d.ts) in Typescript Definition format, which contains TSDoc comments describing what it does.
2020-10-25 20:55:59 +00:00
2020-10-25 21:21:52 +00:00
**Note:** The Obsidian API is still in early alpha and is subject to change at any time!
2020-11-10 07:52:56 +00:00
This sample plugin demonstrates some of the basic functionality the plugin API can do.
- Changes the default font color to red using `styles.css` .
- Adds a ribbon icon, which shows a Notice when clicked.
- Adds a command "Open Sample Modal" which opens a Modal.
- Adds a plugin setting tab to the settings page.
- Registers a global click event and output 'click' to the console.
- Registers a global interval which logs 'setInterval' to the console.
2021-03-01 17:59:44 +00:00
### First time developing plugins?
Quick starting guide for new plugin devs:
2021-03-09 09:47:18 +00:00
- Make a copy of this repo as a template with the "Use this template" button (login to GitHub if you don't see it).
2021-03-07 23:51:48 +00:00
- Clone your repo to a local development folder. For convenience, you can place this folder in your `.obsidian/plugins/your-plugin-name` folder.
2021-03-01 17:59:44 +00:00
- Install NodeJS, then run `npm i` in the command line under your repo folder.
- Run `npm run dev` to compile your plugin from `main.ts` to `main.js` .
- Make changes to `main.ts` (or create new `.ts` files). Those changes should be automatically compiled into `main.js` .
- Reload Obsidian to load the new version of your plugin.
2021-03-07 23:51:48 +00:00
- Enable plugin in settings window.
2020-11-10 07:52:56 +00:00
2020-10-29 00:48:24 +00:00
### Releasing new releases
2020-11-10 07:52:56 +00:00
- Update your `manifest.json` with your new version number, such as `1.0.1` , and the minimum Obsidian version required for your latest release.
- Update your `versions.json` file with `"new-plugin-version": "minimum-obsidian-version"` so older versions of Obsidian can download an older version of your plugin that's compatible.
2020-10-29 01:12:21 +00:00
- Create new GitHub release using your new version number as the "Tag version". Use the exact version number, don't include a prefix `v` . See here for an example: https://github.com/obsidianmd/obsidian-sample-plugin/releases
2020-10-29 00:48:24 +00:00
- Upload the files `manifest.json` , `main.js` , `styles.css` as binary attachments.
- Publish the release.
### Adding your plugin to the community plugin list
- Publish an initial version.
2020-10-29 01:12:21 +00:00
- Make sure you have a `README.md` file in the root of your repo.
2020-10-29 00:48:24 +00:00
- Make a pull request at https://github.com/obsidianmd/obsidian-releases to add your plugin.
2020-10-25 21:21:52 +00:00
### How to use
2020-10-25 20:55:59 +00:00
- Clone this repo.
- `npm i` or `yarn` to install dependencies
- `npm run dev` to start compilation in watch mode.
2020-10-29 00:48:24 +00:00
### Manually installing the plugin
2020-10-25 20:55:59 +00:00
2020-10-29 00:48:24 +00:00
- Copy over `main.js` , `styles.css` , `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/` .
2020-10-25 20:55:59 +00:00
2020-10-26 16:15:09 +00:00
### API Documentation
See https://github.com/obsidianmd/obsidian-api
