x/swarnam-obsidian
1
0
Fork 0
mirror of https://github.com/runofthemillgeek/swarnam-obsidian.git synced 2024-11-16 15:30:16 +00:00
Code Issues Packages Projects Releases Wiki Activity
A no-frills web playground plugin for Obsidian.
15 Commits 1 Branch 2 Tags 553 KiB
TypeScript 50.1%
CSS 25.6%
JavaScript 24.3%
cfe4d17ce7
Go to file
lishid cfe4d17ce7 Add example for settings.
2020-12-22 11:24:00 -05:00
.gitignore Initial commit! 2020-10-25 16:58:31 -04:00
main.ts Add example for settings. 2020-12-22 11:24:00 -05:00
manifest.json Added versions.json 2020-11-10 02:52:56 -05:00
package.json Use rollup for bundling. 2020-10-26 12:02:41 -04:00
README.md Added versions.json 2020-11-10 02:52:56 -05:00
rollup.config.js Use rollup for bundling. 2020-10-26 12:02:41 -04:00
styles.css Initial commit! 2020-10-25 16:58:31 -04:00
tsconfig.json Use rollup for bundling. 2020-10-26 12:02:41 -04:00
versions.json Added versions.json 2020-11-10 02:52:56 -05:00

README.md

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 depends on the latest plugin API (obsidian.d.ts) in Typescript Definition format, which contains TSDoc comments describing what it does.

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, 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.

Adding your plugin to the community plugin list

How to use

  • Clone this repo.
  • npm i or yarn to install dependencies
  • npm run dev to start compilation in watch mode.

Manually installing the plugin

  • Copy over main.js, styles.css, manifest.json to your vault VaultFolder/.obsidian/plugins/your-plugin-id/.

API Documentation

See https://github.com/obsidianmd/obsidian-api