Skip to content

ryankolter/whalesnote

Repository files navigation

Whalesnote (desktop)

A markdown note-taking software that supports win, mac and linux. Easily store and categorize tens of thousands of notes.


Why whalesnote?

  1. Privacy first: local open source software that is not connected to the Internet, giving you complete control over the data(save as .md format).

  2. Markdown support: Additionally provide preview mode and two-column mode.

  3. Super-capacity second brain: three-level directory structure can store at least 100 repositories * 50 categories * 60 notes = 300,000 notes.

  4. Only takes one second to open: no matter how many notes you have, because it use segmentation based search system which won't load all notes at beginning.

  5. Other

    • Perfect shortcut support: like Vimium C, you can quickly switch between notes with the keyboard( Activate with ctrl/command + , ).
    • Export support: allow batch export by notes or categories, with html and md formats.
    • Two mode support: light or dark, as you like.
    • Memory support: it remembers where the document left off last time.

Screenshots

dark mode

note111


shortcut support(like Vimium C on Chrome)

note222


light mode

light_mode


Development

git clone git@github.com/ryankolter/whalesnote.git
npm install
npm run start
  • the web server will run on port 3005

  • then open another terminal

cd app
npm install
npm run electron

Q: What is the benefit of two directory's structure?

A: By seperating app/node_modules from node_modules and building the js bundle file into app directory, we can minimize the packaging size of electron using electron-builder.


License

Look at the LICENSE.md for details

About

A markdown note-taking software that supports win, mac and linux. Easily store and categorize tens of thousands of notes.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published