Can I create commands that only appear when editing markdown?

Yes, by using the editorCallback or editorCheckCallback properties, you can ensure the command is only visible and functional when a markdown editor is active.

How do I ensure my hotkeys work on both Mac and Windows?

Use the 'Mod' modifier in your hotkey configuration; it automatically maps to Command on macOS and Control on Windows and Linux.

What is the difference between callback and checkCallback?

A callback is always visible and executes immediately, whereas a checkCallback allows you to hide the command from the palette if specific conditions, such as an active file, are not met.

Where should I register my Obsidian commands?

All addCommand() calls should be placed within the onload() method of your plugin class to ensure they are properly registered when the plugin is enabled.

Obsidian Command Development

Name: Obsidian Command Development
Author: nthplusio

bynthplusio

•

Gestión de Contenido

Streamlines the implementation of custom commands, hotkeys, and palette actions within the Obsidian plugin ecosystem.

This skill provides expert guidance for developers building Obsidian plugins, focusing on the registration and management of commands within the Command Palette. It covers the full spectrum of command types, including simple callbacks, conditional logic via check callbacks for state-aware visibility, and specialized editor commands for direct text manipulation. By following these patterns, developers can ensure their plugins integrate seamlessly into user workflows with cross-platform hotkey support and optimized performance within the Obsidian environment.

Características Principales

01Cross-platform hotkey configuration using the 'Mod' modifier

02Best practices for avoiding hotkey conflicts in community plugins

03Implementation of simple and conditional command palette entries

04Conditional command visibility using the checkCallback pattern

05Context-aware editor commands for direct markdown manipulation

061 GitHub stars

Casos de Uso

01Building context-sensitive tools that only appear when specific files are active

02Exposing plugin functionality directly to the Obsidian Command Palette

03Creating keyboard shortcuts for frequently used text transformations

Características Principales

01Cross-platform hotkey configuration using the 'Mod' modifier

02Best practices for avoiding hotkey conflicts in community plugins

03Implementation of simple and conditional command palette entries

04Conditional command visibility using the checkCallback pattern

05Context-aware editor commands for direct markdown manipulation

061 GitHub stars

Casos de Uso

01Building context-sensitive tools that only appear when specific files are active

02Exposing plugin functionality directly to the Obsidian Command Palette

03Creating keyboard shortcuts for frequently used text transformations