Structs§
- Command
Editor - An editor that runs a command to launch. This is useful for CLI tools such as
vim
. - Index
Notes Error - Indexed
Note - Indexed
Notes Error - Indexed
Notes With Kind Error - Make
Note Error - An error that occurred during a call to
make_note
. errors section for more details. - Make
OrOpen Daily Note Error - An error that occurred during a call to
make_or_open_daily
. See its errors section for more details. - Note
Config - Note
Preamble - Holds metadata about the note. This metadata is stored in the first section of the note when stored on disk.
- Open
Note Error
Enums§
Traits§
- Editor
- A text editor that can edit a given note. There is no requirement about the editor itself, just that it can edit a file at a given path.
Functions§
- index_
notes - Index all notes in the notes and dailies directories. This will also remove deleted files from the index.
- indexed_
notes - Get all of the notes currently stored in the index, and metadata about them.
- indexed_
notes_ with_ kind - Get all of the notes currently stored in the index with the given kind, and metadata about them.
- make_
note - Create a new note.
- make_
or_ open_ daily - Create or open a daily note for the given date.
- open_
note - Open an existing note at the given path in the editor.