Skip to content

README.md

Latest commit

 

History

History
117 lines (82 loc) · 3.23 KB

README.md

File metadata and controls

117 lines (82 loc) · 3.23 KB
Raw

VoidNotes

https://notes.voidworks.xyz/

A modern, lightweight, and customizable note-taking application built with Go and React. VoidNotes combines elegant design with powerful features to help you organize your thoughts efficiently.

image

Features

  • 📝 Rich Text Editor
  • 🏷️ Note organization with tags
  • 🔍 Full-text search across notes and tags
  • 🎨 Fully customizable UI themes
  • 💨 Lightweight and fast performance
  • 🖥️ Cross-platform support (Windows & MacOS)
  • ⚡ Real-time saving
  • 📊 Word and character count
  • 📋 Task lists and tables support

Installation

  1. Go to the releases page

Windows

  • Download and run the voidnotes-amd64-installer.exe, and then open it.

Mac

  • Download and open the VoidNotes_installer.pkg.
    For Mac, since the installer is not signed, when you first open the file, you will have to click "Done".

    image

    After that, go to Settings, then Privacy & Security, and scroll all the way to the bottom. You'll find a pop-up like this:

    image

    Click Open Anyway

image Lastly, click Open Anyway to continue to the installer

  • Alternatively, you can rebuild and compile the project yourself from source

Usage

Basic Navigation

  • Create new notes using the + button
  • Search notes using the search bar
  • Tag notes for better organization
  • Customize the UI colors in settings

Editor Features

  • Rich text formatting
  • Code blocks with syntax highlighting
  • Task lists
  • Tables
  • Image embedding
  • Links

Customization

VoidNotes offers extensive UI customization options:

  • Sidebar color and opacity
  • Main area color and opacity
  • Header appearance
  • Custom scrollbars
  • Light/Dark theme support

image image

Roadmap

2025

  • Auto Update
  • Search text in note
  • Image embedding support
  • Cloud sync support
  • Enhanced text styling options
  • Note templates
  • Export options (PDF, HTML, Txt)
  • Custom themes marketplace
  • Note version history
  • Note encryption

We welcome contributions! If you have suggestions or want to contribute to the code:

  1. Fork the repository
  2. Create your feature branch
  3. Commit your changes
  4. Push to the branch
  5. Create a Pull Request

Support

If you encounter any issues or have questions:

License

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

Credits

Built with ❤️ by VoidWorks

Note: This is a continuously evolving project. Check back regularly for updates and new features!