mike/Obsidian-Pin-Tab-Button
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added versions.json

Browse Source
This commit is contained in:
lishid
2020-11-10 02:52:56 -05:00
parent 9162f82010
commit 318cb2b055
3 changed files with 24 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -7,9 +7,19 @@ The repo depends on the latest plugin API (obsidian.d.ts) in Typescript Definiti
**Note:** The Obsidian API is still in early alpha and is subject to change at any time!
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.
### Releasing new releases
- Update your `manifest.json` with your new version number, such as `1.0.1`.
- 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.
- 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
- Upload the files `manifest.json`, `main.js`, `styles.css` as binary attachments.
- Publish the release.