https://github.com/abdo-reda/obsidian-sticky-notes-plugin

Obsidian Sticky Notes Plugin
https://github.com/abdo-reda/obsidian-sticky-notes-plugin

obsidian obsidian-plugin sticky-notes

Last synced: 28 days ago
JSON representation

Obsidian Sticky Notes Plugin

• Host: GitHub
• URL: https://github.com/abdo-reda/obsidian-sticky-notes-plugin
• Owner: Abdo-reda
• License: agpl-3.0
• Created: 2025-02-15T21:48:38.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-02-25T12:55:50.000Z (over 1 year ago)
• Last Synced: 2025-02-25T13:22:23.120Z (over 1 year ago)
• Topics: obsidian, obsidian-plugin, sticky-notes
• Language: TypeScript
• Homepage:
• Size: 970 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Sticky Notes Plugin

This is a simple plugin that essentially builds on the popout functionality of obsidian. **_It adds a new popout window that resembles sticky notes_** that haves a much simpler look and adds a pin functionality. 

You can open this popout window using the ribbon action, command, or context menus.

## Demo

![Demo Video](https://github.com/Abdo-reda/obsidian-sticky-notes-plugin/blob/main/assets/demo.gif?raw=true)

## Possible Issues & Limitations.

- Windows (sticky note windows) don't close themselves when obsidian shutsdown, and unfortunely reopen as normal popups when obsidian restarts. (hopefully can be fixed in a future release.)

- There is no Color Settings yet:

    - **Sticky Note default color:** `Yellow color (250, 240, 208)`

- The plugin relies on `@electorn/remote` to work, as the pin functionality and resizing require access to the node/main process apis. This is not the recommended approach, but the only one that worked with me after some research.

- The plugin relies on customizing certain obsidian elements (like the titlebar) and relies on their classes, there is _**no guarentee that this will continue working in future releases of obsidian**_ (if they ever decided to rename their classes for example).

## Installation

- Go to [latest release](https://github.com/Abdo-reda/obsidian-sticky-notes-plugin/releases/latest).

- Download the `sticky-notes.zip` file and extract it inside of your obsidian vault plugins folder `\.obsidian\plugins`.

- Reload obsidian and make sure to enable the plugin in the `community plugins` section in vault settings.

> [!WARNING]  

> Make sure to copy and backup your obsidian notes. This is a just a precaution, the plugin hopefully should be totally safe and no issues have been reported so far.

## Version Workflow

**Creating a Release**

- Bump Vesrion `node version-bump.mjs `

- Push Code.

- Create Tag:

    - `git tag -a  -m ""`

    - `git push origin `

- Edit and Publish Release Notes on Github.

## ENHANCEMENTS

- Add Support for different settings.

    - memorize sticky ntoes

- Fix the bug where sticky notes don't reopen as sticky notes. (close them before obsidian closes, and memorize them in local storage maybe)

    //add settings for remember sticky notes