swarnam-obsidian

mirror of https://github.com/runofthemillgeek/swarnam-obsidian.git synced 2024-11-16 15:30:16 +00:00

A no-frills web playground plugin for Obsidian.

Go to file

lishid 26d068d237 Update readme.		2020-10-28 21:13:03 -04:00
.gitignore	Initial commit!	2020-10-25 16:58:31 -04:00
main.ts	Refactor: Use new version of obsidian.d.ts from remote.	2020-10-26 11:07:18 -04:00
manifest.json	Add version number.	2020-10-28 19:20:59 -04:00
package.json	Use rollup for bundling.	2020-10-26 12:02:41 -04:00
README.md	Update readme.	2020-10-28 21:13:03 -04: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

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!

Releasing new releases

Update your manifest.json with your new version number, such as 1.0.1.
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

Publish an initial version.
Make sure you have a README.md file 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 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