Skip to content

falk-werner/note.rs

Repository files navigation

Build Clippy Test

note.rs

Yet another note taking tool.

note.rs

Features

  • View mode to view existing notes
  • Edit mode to edit new or existing notes
  • create notes using markdown
  • filter existing notes
    • full text search
    • filter by tags
  • insert screenshots
  • storage format conforming to note.spec v1

Accelerators

Key Binding Description
Ctrl + n Create a new note.
Ctrl + d Delete the selected note.
Ctrl + s Sync changes (note that changes are also saved automatically).
Ctrl + b Browse attachments of the selected note.
Ctrl + p Take screenshot.
Ctrl + q Save and exit (note that Alt + F4 will exit without saving).
Ctrl + e Toggle between view mode and edit mode.
Ctrl + f Set focus of search (note that Ctrl + f will open find menu while editing).

Build and run

This project is build with rust and npm. Please see to have it installed beforehand.

Additionally, running note.rs will create a GUI and it needs a display for this. See to have a setup which enables this.

Install dependencies

note.rs uses tauri and vite.

How to setup Ubuntu 21.04 with tauri and vite:

  1. Install tauri's dependencies
    sudo apt-get update
    sudo apt-get install -y \
        libwebkit2gtk-4.1-dev \
        libgtk-3-dev \
        libayatana-appindicator3-dev \
        librsvg2-dev
  2. Install tauri crates
    cargo install tauri-cli
  3. Download npm packages including vite
    npm install

Run in dev mode

cargo tauri dev

References

About

Note taking tool implemented in Rust and JavaScript

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published