# obsidianmd/obsidian-sample-plugin

Template for Obsidian community plugins with build configuration and development best practices.

Repository: https://github.com/obsidianmd/obsidian-sample-plugin
Canonical: https://ross.abutalabs.com/products/obsidian-sample-plugin
Homepage: https://docs.obsidian.md
Language: TypeScript
License: 0BSD
License Family: permissive
Topics: obsidian, obsidian-md, obsidian-plugin, plugin
Last push: 2026-08-02T15:56:53+00:00

## Health v2 (maintenance only)
Score: 66/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 95, release rhythm 8, longevity 100
- inputs: {"age_days": 2138, "days_push": 31, "days_rel": null, "gap_med": null, "n_releases_24m": 0}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 4486, forks 1769 (observed 2026-08-28T04:08:51.250083+00:00)

## What it is
The official template repository for building Obsidian community plugins, written in TypeScript. It includes build configuration, the plugin API type definitions, and examples of common plugin features like commands, modals, ribbon icons, and settings tabs.

## Use cases
- start developing an obsidian plugin
- template for obsidian community plugin
- learn obsidian plugin api basics
- set up typescript build for obsidian plugin
- publish a plugin to obsidian community list
- example of obsidian modal and settings tab

## When to choose
- you want to create a new Obsidian plugin from scratch
- you need a preconfigured TypeScript build setup for Obsidian
- you want reference examples of the Obsidian plugin API

## When to avoid
- you want a ready-to-use plugin with end-user features
- you are building extensions for apps other than Obsidian
- you need a plugin runtime, not a development template

## Facets
- artifact type: plugin
- maturity: active
- function: plugin-system, developer-tools, build-tool
- domain: developer-tools, text-editors
- platform: cross-platform
- tags: obsidian, boilerplate, template, note-taking, desktop, typescript

## Member repositories
- obsidianmd/obsidian-sample-plugin (main) score 66

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:08:51.250083+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-29T18:20:30.504944+00:00, confidence not recorded.
  - readme: https://github.com/obsidianmd/obsidian-sample-plugin (fetched 2026-08-28T04:08:51.250083+00:00, sha abacc9242712)
  - homepage: https://docs.obsidian.md (fetched 2026-08-29T09:07:00.445160+00:00, sha 5ff248b4e448)
- Data as of 2026-08-30T08:39:29.467469+00:00.