A simple zettelkasten journal plugin for Neovim
- Configurable field-notes root location and directory names
- Configurable date formats for filenames
- Simple command
FieldNote(orF) to create new notes and jump to existing notes - Simple command
Journal(orJ) to create new journal entries and traverse existing entries - Automatic note title inferred from git or directory
- Autocomplete for
:Journalcommands - Optional mappings to traverse up/down timescales, and left/right through past and future
- Simple command
LinkNote(orL) to jump to[[link]]under cursor - Automatic
[[link]]creation journal when making a newFieldNote
- Compile command to sync events across timescales
- Autocomplete for
FieldNotecommands - User-configurable templates
- (Feel free to add suggestions via Github issues or a PR)
To install and configure (default shown) with packer:
{
"BlakeJC94/field-notes.nvim",
config = function()
require("field_notes").setup({
--- Root directory of all the notes and journal entries
field_notes_path = vim.fn.expand('~/field-notes'),
--- Names of root subdirectories where notes and journal are located
notes_dir = 'notes',
journal_dir = 'journal',
--- Names of journal subdirectories
journal_subdirs = {
day = 'daily',
week = 'weekly',
month = 'monthly',
},
--- Format that's passed into the `date` command (see `$ man date` for details)
journal_date_title_formats = {
day = "%Y-%m-%d: %a",
week = "%Y-W%W",
month = "%Y-M%m: %b",
},
--- File extension for all files
file_extension = 'md',
--- Optional journal-buffer mappings for `:Journal left/down/up/right`
-- journal_maps = {
-- left = "<Leader><Left>",
-- down = "<Leader><Down>",
-- up = "<Leader><Up>",
-- right = "<Leader><Right>",
-- },
--- Optional auto-linking of notes to current journal
auto_add_links_to_journal = {
day = false,
week = false,
month = false,
},
--- Text that matches title of link list in journals
journal_link_anchor = "## Field notes",
})
end,
}After calling setup(), the :FieldNote and :Journal commands are added to Neovim.
- Opens a new buffer in the current window for the note
- Filename is automatically slugified from title (lowercased and underscored)
- Changes buffer Neovim directory to
field_notes_path
- Opens a new buffer in the current window for the note
- Filename is automatically slugified from title (lowercased and underscored)
- Opened in
field_notes_path/notes_dir - Changes buffer Neovim directory to
field_notes_path
- If
[title] [of] [note]not given,- Title of the note are inferred from current buffer directory
# <repo name>: <branch name>if buffer is in git project# <parent dir>: <current dir>otherwise
- Title of the note are inferred from current buffer directory
- Otherwise, title will be
# <user input to :Note command>
- Title of note is created from
journal_date_title_formats <subcommand>is a timescale (day,week, ormonth), or a direction (left,down,up, orright)- Timescale subcommands open the current time journal entry on the requested timescale
- An optional integer step can be passed in
:Journal <timescale> [step]to step forward to future notes or back into past notes - No step requested rested the step counter
- An optional integer step can be passed in
- Direction subcommands only effective in journal buffers
left/rightto step back/forward between entries in currently viewed timescale
- Timescale subcommands open the current time journal entry on the requested timescale
- Does nothing if not in a field note buffer
- Completion enabled for
note_filename - If called without args
- If cursor is on top of a
[[link_note]], check iflink_note.mdexists in thenotes_dirand jump to the note
- If cursor is on top of a
- If called with a
note_filename,- Check if the
note_filename.mdexists innotes_dir, insert[[note_filename]]at cursor and jump to file
- Check if the
NOTE: This plugin is primarily developed on Linux. This hasn't been tested on Windows or Mac OS, so there may be some unusual quirks on Mac OS. If there are any issues, feel free to open an issue or a PR.
There are many many plugins for note taking in Neovim. Why am I writing another one?
- I'd like to practice a bit more Lua programming
- I want to learn more about testing frameworks in other languages
- I want to learn more about Neovim plugin structure in general
- I want to automate and sync my handwritten note-taking methods within my editor
- Less context switching when coding
This is a admittedly a very opinionated structure, and probably wont be for everyone. However, if you find it useful, leaving a star is always appreciated.
Generally I structure my notes in the following manner:
~/field-notes
├── journal
│ ├── daily
│ │ ├── 2023_01_31_tue.md
│ │ ├── 2023_02_01_wed.md
│ │ ├── 2023_02_02_thu.md
│ │ ...
│ ├── monthly
│ │ ├── 2023_m02_feb.md
│ │ ├── 2023_m03_mar.md
│ │ ...
│ └── weekly
│ ├── 2023_w05.md
│ ├── 2023_w06.md
│ ...
└── notes
├── random_idea_i_had.md
├── another_random_idea_i_had.md
├── project_name_git_branch_1.md
...
└── topic_of_interest.md
- Daily notes:
- Start as blank files, usually just a To-Do list I revisit throughout the day
- This is most useful for stand-up notes
- I can order and prioritise things in this format, which helps me ramble less
- Weekly notes:
- Location for mind dumps, random thoughts and ideas go here throughout the week
- Priority items to look at during the week will go here
- Monthly notes:
- Usually plans for the month ahead (and beyond) at a glance
- Everything else:
- No subdirectories within the
notesdirectory- Zettelkasten method
- Too lazy to maintain a central
index.md - I like the idea of linking files directly to each other
- No subdirectories within the
I keep my field notes in a private git repo. Keeping my notes structured this way keeps it platform independent, and also works on my phone Using an app such as GitJournal or Zettel Notes.