Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aviaryan/VSCodeNotebook
📝 Use VS Code as a reliable note-taking/journal application
https://github.com/aviaryan/VSCodeNotebook
journal note-taking notebook notes visual-studio-code vscode
Last synced: 3 days ago
JSON representation
📝 Use VS Code as a reliable note-taking/journal application
- Host: GitHub
- URL: https://github.com/aviaryan/VSCodeNotebook
- Owner: aviaryan
- License: mit
- Created: 2018-02-11T12:54:40.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-08-16T09:54:44.000Z (about 1 year ago)
- Last Synced: 2024-08-02T13:34:44.532Z (3 months ago)
- Topics: journal, note-taking, notebook, notes, visual-studio-code, vscode
- Language: Python
- Homepage:
- Size: 53.7 KB
- Stars: 639
- Watchers: 25
- Forks: 42
- Open Issues: 7
-
Metadata Files:
- Readme: README.markdown
- License: LICENSE
Awesome Lists containing this project
README
VSCode Notebook :memo:
**v2.1**
VSCode Notebook is an attempt to use VSCode as a complete note taking application.
This is a VSCode port of the popular [SublimeNotebook](https://github.com/aviaryan/SublimeNotebook) project.
## Why did you build this? :thinking:
I have been note-taking for as long as I started using computers. I use notes mostly for technical stuff, but these days I am using notes to record all kinds of information like journals, ideas, snippets etc. In my career, I have tried a number of note-taking tools like OneNote, Evernote, CintaNotes, SimpleNote, Cherrytree, Google Keep, etc. But I have never been satisfied with them mainly because -
1. I don't have any control over how or where my notes are stored. - What if the company closes or the developer stops building the product?
2. Most of these services are paid or work on only certain Operating Systems. And even if they are truly free and cross-platform, they lack critical features like fast full notebook search or hierarchical organization.
Because of these reasons, I had to lose my notes a number of times and was forced to start from scratch. This was frustrating, and finally, I decided to do something about it.
The result is this project, a wrapper/idea that converts my text editor, VSCode, to a feature-rich note-taking tool. Sure it might not be as polished as all those premium note-taking tools, but it works and that too in the way I want it to. And if for some reason I get tired of using VSCode, I can always create a port for another text editor. It will be easy because the dependency on the text editor is very minimal here, not to mention the notes are nothing but plain text files. 😉
## Features :sunglasses:
* Fast Search across all notes
* Hierarchical organization and display of notes
* Password based encryption for notes (thanks to [pyAES](https://github.com/ricmoo/pyaes))
* Cloud sync (Dropbox, Google Drive, Box, etc)
* Periodic git backup (to Github, Gitlab, your own private git server, etc)
* Markdown based markup and code syntax highlighting
## Documentation :yum:
Read [DOCUMENTATION.markdown](DOCUMENTATION.markdown).
## Support the project :money_with_wings:
Are you using this project regularly and find it adding value to your life?
If yes, please consider supporting the author by donating **$5**.
[](https://www.paypal.me/aviaryan/5)