https://github.com/shuckster/denote-md
Shell script for Denote's Markdown + YAML variant
https://github.com/shuckster/denote-md
note-taking shell vim-plugin zettelkasten
Last synced: 5 months ago
JSON representation
Shell script for Denote's Markdown + YAML variant
- Host: GitHub
- URL: https://github.com/shuckster/denote-md
- Owner: shuckster
- License: gpl-3.0
- Created: 2024-01-24T23:21:47.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-25T08:09:53.000Z (almost 2 years ago)
- Last Synced: 2024-08-25T09:25:56.066Z (almost 2 years ago)
- Topics: note-taking, shell, vim-plugin, zettelkasten
- Language: Shell
- Homepage:
- Size: 155 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# denote-md
Shell script for Denote's Markdown + YAML variant.
Latest version: 1.1.2
Denote TL;DR:
It's a note-taking system designed to work well even with basic file-system tools like `ls` and `grep`.
The file-name format:
```
20210319T202401--single-responsibility__software_solid_zettel.md
^_____________^ ^___________________^ ^___________________^
id title tags
```
The front-matter:
```md
---
identifier: "20210815T234244"
date: 2021-08-15T23:42:44.000Z
tags: [ "software", "javascript", "zettel" ]
title: "Currying"
---
```
The links between notes:
```
Hop along to [[denote:20210815T234244]] for more info...
```
Once installed, configure these paths:
```sh
export DENOTE_MD_SCRIPT_PATH=/path/to/denote-md.sh
export DENOTE_MD_NOTES_PATH=/path/to/your/notes/folder/
```
---
Denote was written by Protesilaos Stavrou and is documented here:
- https://protesilaos.com/emacs/denote
This script, denote-md, implements Denote in its Markdown-with-YAML
front-matter variant only, with a couple of extra features that the author
finds personally useful. It was written by Conan Theobald.
There is a companion Vim plugin available.
- https://github.com/shuckster/vim-denote-md
CLI usage:
```
Usage: denote-md.sh [-g] []
new [tags] [title]
get filename [identifier]
get title note.md
replace title [new_title] *.md
list tags [*.md]
list notes [tags]
list recent [num_notes]
list backlinks note.md
list heading [heading] [tags]
list actions [tags]
add tag [tag] *.md
remove tag [tag] *.md
rename tag [tag] [new_name] *.md
replace tags [new_tags] *.md
refresh *.md
env Print environment variables
```
Commands that accept globs can also read files from `stdin`, eg:
```
ls *.md|denote-md list tags
```
Prefixing a command with `-g` will enable colour for any printed filenames.
Except for `new`, commands with missing arguments will print help and an
example for that command. The `new` command will prompt for missing arguments.
No command is confirmed before being executed, so please use in combination
with version control. You have been warned.
## Credits
Props to
[u/varsderk](https://www.reddit.com/r/vim/comments/17vm4i8/re_denote_for_vim_fineill_make_a_crappy_version/)
for introducing me to [denote](https://protesilaos.com/emacs/denote).
`denote-md` was written by [Conan Theobald](https://github.com/shuckster/).
I hope you found it useful! If so, I like [coffee ☕️](https://www.buymeacoffee.com/shuckster) :)