Skip to content

Obsidian Buttons Plugin

The Obsidian Buttons Plugin is a community plugin for Obsidian that allows users to create interactive buttons within notes.^[200-學習OB__plugin__buttons.md, 600-developer__tools__obsidian__obsidian-buttons-create.md]

Functionality

The plugin enables the creation of buttons by using a specific code block syntax (```button) within markdown notes.^[200-學習OB__plugin__buttons.md, 600-developer__tools__obsidian__obsidian-buttons-create.md]

Button Types

Users can create different types of buttons depending on the desired action:

  • Command Buttons: The simplest form of button, defined by a name parameter.^[200-學習OB__plugin__buttons.md#L10-11, 600-developer__tools__obsidian__obsidian-buttons-create.md#L12-13]
  • Link Buttons: These buttons navigate to a specific URL or file.^[200-學習OB__plugin__buttons.md#L14-19, 600-developer__tools__obsidian__obsidian-buttons-create.md#L16-21]

Parameters

Buttons can be customized using various arguments within the code block:

  • name: Sets the text label displayed on the button.^[200-學習OB__plugin__buttons.md#L10, 600-developer__tools__obsidian__obsidian-buttons-create.md#L12]
  • type: Defines the behavior, such as link for opening URLs.^[200-學習OB__plugin__buttons.md#L15, 600-developer__tools__obsidian__obsidian-buttons-create.md#L17]
  • action: Specifies the destination URL or command target.^[200-學習OB__plugin__buttons.md#L16, 600-developer__tools__obsidian__obsidian-buttons-create.md#L18]
  • color: Changes the visual color of the button (e.g., blue).^[200-學習OB__plugin__buttons.md#L19, 600-developer__tools__obsidian__obsidian-buttons-create.md#L21]
  • templater: A boolean flag (e.g., true) that enables integration with the [[Templater]] plugin.^[200-學習OB__plugin__buttons.md#L18, 600-developer__tools__obsidian__obsidian-buttons-create.md#L20]

Examples

Basic Command Button 

name Btn

Link Button with Styling 

name github-buttons
type link
action https://github.com/shabegom/buttons
templater true  
color blue
^[200-學習OB__plugin__buttons.md, 600-developer__tools__obsidian__obsidian-buttons-create.md]

Sources

  • 200-學習OB__plugin__buttons.md
  • 600-developer__tools__obsidian__obsidian-buttons-create.md