You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1.4 KiB
1.4 KiB
Development notes
Releasing new releases
- Update
versioninpackage.json - Run
npm run versionto updatemanifest.json&versions.jsonmanifest.json: holds the new version number and the minimum Obsidian version required for your latest release.versions.json: holds the history of version numbers and their 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
meld-encrypt-<ver>.zip,manifest.json,main.js,styles.cssas binary attachments. - Publish the release.
Adding your plugin to the community plugin list
- Publish an initial version.
- Make sure you have a
README.mdfile in the root of your repo. - Make a pull request at https://github.com/obsidianmd/obsidian-releases to add your plugin.
How to use
- Clone this repo.
npm ioryarnto install dependenciesnpm run devto start compilation in watch mode.
Manually installing the plugin
- Copy over
main.js,styles.css,manifest.jsonto your vaultVaultFolder/.obsidian/plugins/your-plugin-id/.