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-10-29 00:48:24 +00:00
|
|
|
### Releasing new releases
|
|
|
|
|
|
|
|
|
|
- Update your `manifest.json` with your new version number, such as `1.0.1`.
|
|
|
|
|
- Create new GitHub release. Use your version number as the "Tag version". Use the exact version number, don't include the prefix `v`.
|
|
|
|
|
- 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.
|
|
|
|
|
- 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
|
