Skip to content

dsabolo/quicknotes

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Quick Notes GNOME Shell Extension

A simple and efficient note-taking extension for GNOME Shell that allows you to create, edit, and manage your notes directly from the top bar.

Installation

From extensions.gnome.org

(Coming soon)

Manual Installation

  1. Clone this repository:

    git clone https://github.com/dsabolo/quicknotes.git
  2. Copy the extension to GNOME Shell's extensions directory:

    cp -r quicknotes ~/.local/share/gnome-shell/extensions/quicknotes@dsabolo.github.io
  3. Restart GNOME Shell:

    • On X11: Press Alt+F2, type 'r' and press Enter
    • On Wayland: Log out and log back in
  4. Enable the extension:

    gnome-extensions enable quicknotes@dsabolo.github.io

Usage

  1. Click the Quick Notes icon in the top bar (looks like a text editor)

  2. To create a new note:

    • Click "Add Note"
    • Enter a title for your note
    • Click "Create"
  3. To edit a note:

    • Click the edit (pencil) icon next to the note
    • Your default text editor will open with the note
  4. To delete a note:

    • Click the delete (trash) icon next to the note
  5. To search notes:

    • Type in the search box
    • Notes will be filtered in real-time as you type
  6. To access your notes folder:

    • Click "Open Notes Folder"

Storage

Notes are stored as markdown files in the ~/.quicknotes directory. Each note is saved with the .md extension, making them easily readable and editable with any text editor.

Requirements

  • GNOME Shell 42
  • A text editor for editing notes (the system default will be used)

Development

To contribute to Quick Notes:

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Submit a pull request

License

This extension is released under the MIT License. See the LICENSE file for more details.

Author

Diego Sabolo

Acknowledgments

  • GNOME Shell development team for their excellent documentation
  • The GNOME Shell extensions community for inspiration and examples

Support

If you encounter any issues or have suggestions, please file them in the GitHub Issues section.

About

A GNOME Shell Extension for creating and manage notes.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published