Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oem/arachne.nvim
A minimal note-taking system for neovim
https://github.com/oem/arachne.nvim
neovim note-taking vim
Last synced: 7 days ago
JSON representation
A minimal note-taking system for neovim
- Host: GitHub
- URL: https://github.com/oem/arachne.nvim
- Owner: oem
- License: unlicense
- Created: 2022-09-22T10:21:23.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-06-19T14:14:01.000Z (over 1 year ago)
- Last Synced: 2024-08-01T22:54:09.660Z (3 months ago)
- Topics: neovim, note-taking, vim
- Language: Lua
- Homepage:
- Size: 17.6 KB
- Stars: 28
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# arachne.nvim
A very minimal, notetaking system for neovim.
## TL;DR
Check out this [scuffed video](https://asciinema.org/a/523779) if you want to see it in action (asciinema might have some trouble with the telescope dialog window :) ).
A plugin that allows you to quickly capture notes, all the while not locking you into a system so that you can easily combine it with other tools.
The notes are in the markdown format, but I might add options for other formats if there is any interest.
You can "tag" your notes to find them easier/group them. Those tags are part of the filename To follow the low-tech philosophy. This allows you to use any of the tools you would usually use to find files.
A bit further down you will find an example on how to use Telescope.nvim to fuzzy find your notes or search in them.
An example note file might be named like this:
`2022-09-25--long-term-storage__public_thoughts.md`
"long-term-storage" is derived from the title you would provide, while public and thoughts are the tags.
## Usage
### Install
You can use the plugin manager of you choice, here is an example using packer.nvim:
```lua
use { 'oem/arachne.nvim' }
```
### Configure
There is not much to configure right now, in fact you can currently only configure the directory of your notes:
```lua
use { 'oem/arachne.nvim', config = function() require('arachne').setup { notes_directory = '/home/moi/zettelkasten' } }
```
Here is my setup, including a keybindining to create new notes:
```lua
use {
"oem/arachne.nvim",
config = function()
require('arachne').setup {notes_directory = "/home/oem/sync/notes"}
end,
setup = function()
vim.keymap.set('n', 'nn',
function() return require('arachne').new() end)
vim.keymap.set('n', 'nr',
function() return require('arachne').rename() end)
end
}
```
And here is an example on how to use telescope to have a very powerful search/retrieve system for your notes (this assumes your notes live in `~/notes`):
```lua
local M = {}
M.find_notes = function()
require('telescope.builtin').find_files {
prompt_title = '',
cwd = '~/notes'
}
end
M.search_notes = function()
require('telescope.builtin').live_grep {
prompt_title = '',
cwd = '~/notes'
}
end
return M
```
Keybind those two functions and you have a pretty powerful note retrieval system!
You can find a working example in my [dotfiles](https://github.com/oem/dotfiles/blob/main/neovim/.config/nvim/lua/config/telescope_setup.lua).
### API
Following functions are provided for your usage:
**new**
Will trigger the flow to create a new note.
```lua
require('arachne').new()
```
**rename**
Allows the renaming of the note, by providing a new title and tags (or reusing the old ones):
```lua
require('arachne').rename()
```
## Inspiration
The low-tech philosophy is loosely inspired by [denote.el](https://github.com/protesilaos/denote) and more generally by the unix philosophy of minimal and modular tools.