obsidianmd/obsidian-sample-plugin
Obsidian Sample Plugin
This project is a TypeScript plugin boilerplate and template for creating community extensions for the Obsidian knowledge base application. It provides a foundational codebase and starter project designed to implement development best practices for building and distributing plugins.
The repository includes a Deno-based project bootstrapper that automates the generation of a TypeScript project template, including the necessary build configurations and definitions.
The project covers the full development workflow for extensions, including TypeScript-to-JavaScript transpilation, asset packaging via a bundler, and the implementation of the plugin lifecycle. It utilizes interface-based type definitions and module-based configuration to ensure compatibility with the host application.
Features
- Obsidian Plugin Development - Provides a complete development environment and template for creating custom community extensions for Obsidian.
- Starter Templates - A foundational codebase that implements development best practices for building and distributing Obsidian plugins.
- TypeScript Starters - Ships a TypeScript project starter tailored for creating community extensions for the Obsidian application.
- Community Extension Integrators - Provides the foundational tooling and configurations necessary for developing and distributing community-driven extensions.
- TypeScript Plugin Authoring - Provides a pre-configured development environment with build scripts and type definitions for authoring TypeScript plugins.
- Project Bootstrappers - Ships a Deno-based utility to generate the initial file structure and build configurations for new plugins.
- Interface Type Definitions - Provides interface-based type definitions to ensure compatibility with the host application's internal object models.
- JavaScript Module Bundlers - Uses a bundler to combine multiple TypeScript modules into a single JavaScript file for the host application.
- Source-to-JavaScript Transpilers - Transpiles type-safe TypeScript source code into executable JavaScript files compatible with the host runtime.
- Plugin Lifecycle Hooks - Implements hooks that allow plugins to initialize and shut down during the host application's loading sequence.
- أدوات المطور - Official boilerplate for creating new plugins.
