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.
Quick starting guide for new plugin devs:
.obsidian/plugins/your-plugin-name
folder.npm i
in the command line under your repo folder.npm run dev
to compile your plugin from main.ts
to main.js
.main.ts
(or create new .ts
files). Those changes should be automatically compiled into main.js
.npm update
in the command line under your repo folder.manifest.json
with your new version number, such as 1.0.1
, and the minimum Obsidian version required for your latest release.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.v
. See here for an example: https://github.com/obsidianmd/obsidian-sample-plugin/releasesmanifest.json
, main.js
, styles.css
as binary attachments. Note: The manifest.json file must be in two places, first the root path of your repository and also in the release.You can simplify the version bump process by running
npm version patch
,npm version minor
ornpm version major
after updatingminAppVersion
manually inmanifest.json
. The command will bump version inmanifest.json
andpackage.json
, and add the entry for the new version toversions.json
README.md
file in the root of your repo.node --version
).npm i
or yarn
to install dependencies.npm run dev
to start compilation in watch mode.main.js
, styles.css
, manifest.json
to your vault VaultFolder/.obsidian/plugins/your-plugin-id/
.npm install -g eslint
eslint main.ts
src
, you can use eslint with this command to analyze all files in that folder:
eslint .\src\