x/swarnam-obsidian
1
0
Fork 0
mirror of https://github.com/runofthemillgeek/swarnam-obsidian.git synced 2024-11-16 07:20:16 +00:00
Code Issues Packages Projects Releases Wiki Activity
08add6702a
swarnam-obsidian/README.md
lishid 08add6702a Update readme.
2020-10-28 20:48:24 -04:00

1.3 KiB
Raw Blame History

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!

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

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