Skip to content

Buttons plugin (Obsidian)

The Buttons plugin (often referred to as Buttons) is a community plugin for Obsidian that allows users to create and embed interactive buttons within notes^[600-developer__tools__obsidian__obsidian-buttons-create.md].

Features

The plugin allows for the creation of various types of buttons, including command buttons and link buttons^[600-developer__tools__obsidian__obsidian-buttons-create.md]. Users can customize the appearance and behavior of these buttons using specific parameters within a code block.

Button Types and Parameters

  • name: Defines the text label displayed on the button^[600-developer__tools__obsidian__obsidian-buttons-create.md].
  • type: Specifies the functionality of the button. Common values include link to open a URL or file^[600-developer__tools__obsidian__obsidian-buttons-create.md].
  • action: Determines the target destination or command executed when the button is clicked, such as a web URL^[600-developer__tools__obsidian__obsidian-buttons-create.md].
  • color: Sets the color of the button text or background (e.g., blue)^[600-developer__tools__obsidian__obsidian-buttons-create.md].
  • templater: A boolean parameter (e.g., true) that integrates with the Templater plugin to process commands or templates^[600-developer__tools__obsidian__obsidian-buttons-create.md].

Usage

To create a button, users must enclose the button parameters in a code block tagged with button^[600-developer__tools__obsidian__obsidian-buttons-create.md].

Example: Link Button The following code creates a button labeled "github-buttons" that opens the plugin's GitHub repository in blue text^[600-developer__tools__obsidian__obsidian-buttons-create.md]:

```button
name github-buttons
type link
action https://github.com/shabegom/buttons
color blue
```

Sources

^[600-developer__tools__obsidian__obsidian-buttons-create.md]