No description
Find a file
Andrea Alberti eb6b4da724 Small fix
2024-06-01 23:23:47 +02:00
docs/images buy me coffee 2024-06-01 22:10:11 +02:00
src Small change 2024-06-01 23:18:15 +02:00
styles Gray out placeholders 2024-06-01 22:51:47 +02:00
.editorconfig Add files via upload 2024-06-01 19:37:17 +02:00
.eslintignore Add files via upload 2024-06-01 19:37:17 +02:00
.eslintrc Add files via upload 2024-06-01 19:37:17 +02:00
.gitignore Add files via upload 2024-06-01 19:37:17 +02:00
.npmrc Add files via upload 2024-06-01 19:37:17 +02:00
esbuild.config.mjs First import 2024-06-01 19:35:27 +02:00
LICENSE Added license 2024-06-01 22:05:54 +02:00
manifest.json Small fix 2024-06-01 23:23:47 +02:00
package-lock.json First import 2024-06-01 19:35:27 +02:00
package.json First import 2024-06-01 19:35:27 +02:00
README.md Extended readme 2024-06-01 22:09:34 +02:00
tsconfig.json First import 2024-06-01 19:35:27 +02:00
version-bump.mjs First import 2024-06-01 19:35:27 +02:00
versions.json First import 2024-06-01 19:35:27 +02:00

Obsidian Plugin Comment

Obsidian Plugin Comment is a plugin for Obsidian that allows users to add personal annotations to each installed plugin. This is particularly useful for keeping track of why certain plugins are installed and their specific use cases.

Features

  • Add personal annotations to any installed plugin in the settings pane.
  • Annotations are saved persistently and can be edited at any time.
  • Annotations are displayed directly below the plugin information.

Installation

  1. Download the latest release from the Releases page.
  2. Extract the files into your Obsidian plugins folder: <vault>/.obsidian/plugins/obsidian-plugin-comment.
  3. Enable the plugin in the "Community plugins" settings pane.

Usage

  1. Open the "Community plugins" settings pane.
  2. You will see a text area below each installed plugin where you can add your personal annotation.
  3. Annotations are automatically saved and will be displayed whenever you open the settings pane.

Screenshot

Screenshot of the setting pane showing installed plugins with annotations by the user

Development

To contribute to the development of this plugin, follow these steps:

  1. Fork the repository on GitHub.
  2. Clone your forked repository:
    git clone https://github.com/your-username/obsidian-plugin-comment.git
    
  3. Navigate to the plugin directory:
    cd obsidian-plugin-comment
    
  4. Install the dependencies:
    npm install
    
  5. Build the plugin:
    npm run build
    
  6. Enable the plugin in Obsidian and start developing!

Donations

I would be grateful for any donation to support the development of this plugin.

Buy Me a Coffee QR Code

Author

  • Author: Andrea Alberti
  • GitHub Profile: alberti42
  • Donations: Buy Me a Coffee

Feel free to contribute to the development of this plugin or report any issues in the GitHub repository.