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.
7 Commits 1 Branch 2 Tags 553 KiB
TypeScript 50.1%
CSS 25.6%
JavaScript 24.3%
ed97541d3b
Go to file
lishid ed97541d3b Add version number.
2020-10-28 19:20:59 -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-26 12:15:09 -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 contains 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!

How to use

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

How to install the plugin

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

API Documentation

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