mirror of
https://github.com/tomasriveral/NoteWrapper.git
synced 2026-08-12 02:18:38 +02:00
48 lines
2.7 KiB
Markdown
48 lines
2.7 KiB
Markdown
### Why?
|
||
I started journaling and notetaking with **[Obsidian](https://obsidian.md/)**, but wanted to only use free software. I also tried **[Logseq](https://logseq.com/)** and **[Joplin](https://github.com/laurent22/joplin)**, but preferred a terminal-based app.
|
||
|
||
Using my Neovim setup, I explored plugins like **[neorg](https://github.com/nvim-neorg/neorg)**, **[orgmode](https://github.com/nvim-orgmode)**, and **[today.nvim](https://github.com/VVoruganti/today.nvim)**. While they offered useful features, none fully met my needs: some lacked external Markdown rendering, some used custom file formats, and some didn’t provide a true journal mode. For real-time Markdown rendering from Neovim, I found **[Vivify](https://github.com/jannis-baum/Vivify/)**, which NoteWrapper relies on.
|
||
|
||
The goal was a terminal-based interface for accessing vaults and notes using standard Markdown, with minimal extra features. Although it currently works only with Neovim, it is designed as a standalone wrapper that could be adapted for other editors with minimal changes.
|
||
|
||
### How to install
|
||
1. Have installed `neovim`, `ncurses`. `cjson` and `pkg-config`.
|
||
2. Clone the repository.
|
||
```shell
|
||
git clone https://github.com/Totorile1/NoteWrapper.git
|
||
```
|
||
3. Compile the project. If you are on NixOS and have direnv installed, run `direnv allow`. It will create the nix-shell which will get all the necessary libraries.
|
||
```
|
||
cd NoteWrapper
|
||
make
|
||
```
|
||
4. configure `./config.json`
|
||
5. run the binary `notewrapper`
|
||
|
||
### Usage
|
||
If you want to render with Vivify with the flags `-r`, `--render` or with the option in the config file, you must have installed the plugins for your specific editor ([for Vim and Neovim](https://github.com/jannis-baum/vivify.vim))
|
||
|
||
### Configuration
|
||
Change `$/.config/notewrapper/config.json`. If it does not exist. On building, it should copy a default config.
|
||
|
||
### What needs to be done (a lot)
|
||
- [x] Add a way to create vaults
|
||
- [x] Add a way to delete vaults
|
||
- [ ] Add a way to delete notes
|
||
- [x] Stylisize a bit the TUI
|
||
- [x] Add more options to the config file
|
||
- [x] Search for config.json in other directories such as ~/.config/notewrapper/ and not only this directory
|
||
- [x] Port vivify.vim to nixpkgs
|
||
- [ ] Add a way to have vaults in different directories
|
||
- [x] Actually open vivify when opening nvim
|
||
- [ ] Write the journaling code (separate files or one big journal files)
|
||
- [ ] Automatic backups
|
||
- [x] Add flags for customization
|
||
- [ ] Write a good README.md
|
||
- [x] Option to not render and to only open nvim
|
||
- [ ] Figure out this vivify issue https://github.com/jannis-baum/Vivify/issues/291
|
||
- [ ] Maybe port this to other editors
|
||
- [ ] Port to vim
|
||
- [ ] Fixe all the small stuff marked //(TODO LATER) in the code
|
||
- [ ] Add a way to delete notes
|