aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDefaultGen <gravel.justness270@slmail.me>2024-06-05 00:36:46 -0400
committerDefaultGen <gravel.justness270@slmail.me>2024-06-05 00:36:46 -0400
commitc625270f9d8f156c0c1c32c10e662a68a0fb0694 (patch)
treee8c99038a08775b849a1f561c73cce1550347831 /README.md
parent49a64acdb30ee7643b249e5441447478726250ca (diff)
downloadsimple-denote.nvim-c625270f9d8f156c0c1c32c10e662a68a0fb0694.tar.gz
Minor changes
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 3 insertions, 7 deletions
diff --git a/README.md b/README.md
index dbc87da..c93aa29 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,9 @@
# simple-denote.nvim
-This plugin provides a command `:Denote note` that prompts for a title and tags, then creates a new file using the emacs `denote` package file-naming scheme:
+This plugin provides a command `:Denote note` that prompts for a title and tags, then creates a new file in your notes directory using the emacs `denote` package file-naming scheme:
`DATE==SIGNATURE--TITLE__KEYWORDS.EXTENSION`
-![](https://i.imgur.com/sRlQeMk.mp4)
-
For example:
1. `20240601T174946--how-to-tie-a-tie__lifeskills_clothes.md`
2. `20240601T180054--i-have-no-tags.md`
@@ -13,9 +11,7 @@ For example:
4. `20240601T200121.md`
5. `20240601T213392=1a1--i-have-a-signature__denote_coolstuff.md` (Not yet implemented)
-There is no support for frontmatter, links, or any other denote features. I just like the file-naming scheme. It's easy to parse, search, and sort chronologically.
-
-You can read more about the denote file-naming scheme here:
+There is no support for frontmatter, links, or any other denote features. I just like the file-naming scheme. It's easy to parse, search, and sort chronologically. You can read more about it here:
https://protesilaos.com/emacs/denote#h:4e9c7512-84dc-4dfb-9fa9-e15d51178e5d
# Installation / Config
@@ -26,7 +22,7 @@ Example config via [lazy.nvim](https://github.com/folke/lazy.nvim)
{
"DefaultGen/simple-denote.nvim",
opts = {
- ext = "md", -- Note file extension
+ ext = "md", -- Note file extension (e.g. md, org, norg)
dir = "~/notes", -- Notes directory (should already exist)
add_heading = true, -- Add a md/org heading to new notes
retitle_heading = true, -- Replace the first line with a new heading when retitling