MCPcopy Index your code
hub / github.com/obsidianmd/obsidian-sample-plugin

github.com/obsidianmd/obsidian-sample-plugin @1.0.0 sqlite

repository ↗ · DeepWiki ↗ · release 1.0.0 ↗
13 symbols 15 edges 2 files 0 documented · 0%
README

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

Core symbols most depended-on inside this repo

onInit
called by 0
main.ts
onload
called by 0
main.ts
onunload
called by 0
main.ts
constructor
called by 0
main.ts
onOpen
called by 0
main.ts
onClose
called by 0
main.ts
display
called by 0
main.ts

Shape

Method 7
Class 6

Languages

TypeScript100%

Modules by API surface

main.ts13 symbols

Dependencies from manifests, versioned

@rollup/plugin-commonjs15.1.0 · 1×
@rollup/plugin-node-resolve9.0.0 · 1×
@rollup/plugin-typescript6.0.0 · 1×
@types/node14.14.2 · 1×
obsidianhttps://github.com/o · 1×
rollup2.32.1 · 1×
tslib2.0.3 · 1×
typescript4.0.3 · 1×

For agents

$ claude mcp add obsidian-sample-plugin \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact