This document provides an overview of the features included in plugins built with this template.

Table of Contents

Core Features

Modern Build System

Fast, efficient compilation with esbuild

Benefits:

Learn more: Build System Documentation

Modular CSS System

Organized stylesheets that compile to a single file

Source files:

src/styles/
├── base.css        # Base styles and variables
├── modals.css      # Modal dialog styles
├── settings.css    # Settings tab styles
└── components.css  # UI component styles

Benefits:

Learn more: CSS Guidelines

Advanced Logging System

Component-based logging with production safety

Example:

import { createLogger } from '../utils/Logger';

class MyComponent {
    private logger = createLogger('ui');
    
    someMethod() {
        this.logger.debug('Method called', { data });
        this.logger.info('Operation completed');
        this.logger.warn('Warning condition');
        this.logger.error('Error occurred', error);
    }
}

Benefits:

Learn more:

Development Features

TypeScript Configuration

Full type safety and modern JavaScript

File Size Limits

Enforced modularity for maintainability

Limits:

Learn more: Coding Standards

Documentation Structure

Organized, comprehensive documentation

Structure:

docs/                  # Public (on GitHub Pages)
├── user/             # End-user documentation
├── developer/        # Contributing and development
├── features/         # Feature documentation
└── examples/         # Code examples

docs-internal/         # Private (local only)
├── sessions/         # Development session notes
├── guides/           # Internal development guides
├── references/       # Quick references
└── maintenance/      # TODOs and plans

User Features

Settings Tab

Configurable plugin behavior

Command Palette Integration

Quick access to plugin features

Interactive user interfaces

Technical Features

Release Management

Automated versioning and packaging

Commands:

npm run release      # Create versioned release
npm run build        # Production build
npm run dev          # Development build

Hot Reload Support

Fast development workflow

Error Handling

Robust error management

Planned Features

Coming Soon

These features are planned for future releases:

See the Roadmap for details.

Feature Requests

Have an idea for a new feature?

  1. Check the Roadmap to see if it’s planned
  2. Search GitHub Issues for existing requests
  3. Create a new feature request with:
    • Clear description of the feature
    • Use cases and benefits
    • Examples of similar features (if any)

Feature Comparison

vs. Basic Template

Compared to Obsidian’s sample plugin:

Feature Basic Template This Template
Build System webpack ⚡ esbuild (10x faster)
CSS Organization Single file 📁 Modular files
Logging console.log 🏷️ Component-based logger
Debug Code Manual removal 🗜️ Auto-elimination
Documentation README only 📚 Full docs structure
Release Tools Manual 📦 Automated
File Limits None 📏 Enforced modularity
Type Safety Basic ✅ Strict TypeScript

vs. Manual Setup

Starting from scratch vs. using this template:

Task Manual Setup This Template
Initial Setup 4-8 hours ⚡ 5 minutes
Build System 2-4 hours ✅ Pre-configured
CSS Pipeline 1-2 hours ✅ Ready to use
Logging System 3-6 hours ✅ Included
Documentation Varies ✅ Structure ready
Best Practices Learn/implement ✅ Built-in

Performance

Build Times

Development mode:

Production mode:

Bundle Sizes

Typical bundle sizes for plugins built with this template:

With debug elimination:

Browser Compatibility

Compatible with:

Operating System Support

Works on all Obsidian-supported platforms:

Learn More

Questions? Check the FAQ or create an issue.