Skip to content

Repository files navigation

Better Checkboxes

Overview

Simple Obsidian plugin that adds a dropdown menu of all of the options for a checkbox so you don't have to memorize the .md syntax for each one.

Tutorial

LALT + click on a checkbox to open the menu.

Features

  • Checkbox Options: Users can enable or disable a whichever chechbox options they want to see in the dropdown menu.
  • Settings Page: Preference management.
  • Dynamic Dropdown Menu: The dropdown menu displays options based on user settings, allowing for quick selection and insertion into notes.

Installation

  1. Clone the repository to your local machine.
  2. Navigate to the plugin directory in your terminal.
  3. Run npm install to install the necessary dependencies.
  4. Open Obsidian and enable the plugin in the settings.
  5. Reload Obsidian CTRL + P -> "Reload Plugin"

Usage

  1. Accessing the Settings Page:
    • Open the settings tab in Obsidian.
    • Navigate to the "My Plugin" section to view and modify your settings.
  2. Managing Checkbox Options:
    • In the settings page, you will see a list of options with descriptive labels and corresponding emojis.
    • Toggle the switches to enable or disable specific features.
  3. Using Right-Click Functionality:
    • Right-click on any checkbox in your notes to bring up the options menu.
    • Select the desired option to insert it directly into your note.

Configuration

The plugin allows for the following configurations:

  • Checkbox Options: Each option can be enabled or disabled, affecting how they appear in the dropdown menu.
  • Display Options: Choose how options are displayed in the dropdown menu (text, emoji, or both).

Contributing

Contributions are welcome! If you have suggestions for improvements or new features, feel free to open an issue or submit a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Upcoming Features (Probably idk)

  • Having css style sync to the users obsidian theme

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages