aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 9 insertions, 9 deletions
diff --git a/README.md b/README.md
index 73c3fc2..9d53b6e 100644
--- a/README.md
+++ b/README.md
@@ -1,19 +1,19 @@
# simple-denote.nvim
-This Neovim plugin provides a command `:Denote note` that prompts for a title and tags, then creates a new file in a flat notes directory using the [Emacs Denote package's file-naming scheme](https://protesilaos.com/emacs/denote#h:4e9c7512-84dc-4dfb-9fa9-e15d51178e5d):
+This Neovim plugin provides a command `:Denote note` that prompts for a title and keywords (tags), then creates a new file in a flat notes directory using the [Emacs Denote package's file-naming scheme](https://protesilaos.com/emacs/denote#h:4e9c7512-84dc-4dfb-9fa9-e15d51178e5d):
`DATE==SIGNATURE--TITLE__KEYWORDS.EXTENSION`
For example:
1. `20240601T174946--how-to-tie-a-tie__lifeskills_clothes.md`
-2. `20240601T180054--i-have-no-tags.org`
-3. `20240601T193022__im_only_tags.norg`
+2. `20240601T180054--title-only.org`
+3. `20240601T193022__only_keywords.norg`
4. `20240601T200121.txt`
-5. `20240601T213392==1a1--i-have-a-signature__denote_coolstuff.csv`
+5. `20240601T213392==1a1--i-have-a-signature__denote.csv`
That's all this does: create and consistently rename text files using the above scheme. No frontmatter, links, etc. I have overcomplicated my notes too many times with fancy Org Mode and Zettelkasten systems and this is my minimalist endgame.
-The file-naming should be 1:1 with denote.el, down to minor things like triming/combining excess whitespace, removing special characters, disallowing multi-word keywords (tags), and separating signature terms with = (e.g. `==three=word=sig`).
+The file-naming should be 1:1 with denote.el, down to minor things like triming/combining excess whitespace, removing special characters, disallowing multi-word keywords, and separating signature terms with = (e.g. `==three=word=sig`).
# Installation / Config
@@ -40,7 +40,7 @@ Maybe you want to set keymaps for the commands as well
```lua
vim.keymap.set({'n','v'}, '<leader>nn', ":Denote note<cr>", { desc = "New note" })
vim.keymap.set({'n','v'}, '<leader>nt', ":Denote title<cr>", { desc = "Change title" })
-vim.keymap.set({'n','v'}, '<leader>nk', ":Denote tag<cr>", { desc = "Change tags" })
+vim.keymap.set({'n','v'}, '<leader>nk', ":Denote keywords<cr>", { desc = "Change keywords" })
vim.keymap.set({'n','v'}, '<leader>nz', ":Denote signature<cr>", { desc = "Change signature" })
```
@@ -76,15 +76,15 @@ git pull
```vim
" Creates a new note in the `dir` directory with `ext` extension
-" Tags are space delimited. The title or tags can be blank.
+" Keywords are space delimited. The title or keywords can be blank.
:Denote note
" Renames the current note with the new title
" If `retitle_heading` is true, overwrites the first line heading as well
:Denote title
-" Renames the current note with the new list of tags (space delimited)
-:Denote tag
+" Renames the current note with the new list of keywords (space delimited)
+:Denote keywords
" Rename the current note with a signature
" This has a user-defined meaning and no particular purpose