https://github.com/pinjasaur/jot
Jot down notes in Markdown. :pencil2:
https://github.com/pinjasaur/jot
bash-script markdown note-taking notes
Last synced: over 1 year ago
JSON representation
Jot down notes in Markdown. :pencil2:
- Host: GitHub
- URL: https://github.com/pinjasaur/jot
- Owner: Pinjasaur
- Created: 2017-08-02T06:09:13.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2020-05-23T22:36:53.000Z (about 6 years ago)
- Last Synced: 2025-01-26T19:22:22.367Z (over 1 year ago)
- Topics: bash-script, markdown, note-taking, notes
- Language: Shell
- Homepage:
- Size: 19.5 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# jot
[](https://travis-ci.org/Pinjasaur/jot)
Jot down notes in Markdown.
Inspired by [sts10/jot](https://github.com/sts10/jot).
Requires Bash >= 4 (for [`globstar`][globstar]).
## Installation
Add the [`jot` script](/jot) to your `$PATH` or create a function similar to:
```bash
jot() {
/path/to/jot "${@}"
}
```
`jot` defaults to writing to `$HOME/Notes`. You can customize this by setting
`$JOT_DIR` to something else (e.g. `export JOT_DIR="$HOME/Dropbox/Notes"`).
You'll also want to make sure `$EDITOR` is set to your preferred editor
(e.g. `export EDITOR='vim'`).
## Usage
Run `jot ` to start writing. You can list notes with `jot --list` and show
the usage info with `jot --help`:
```
jot []
Options:
-h --help Show this.
-l --list List notes.
Create a note named .md.
If no , the default is YYYY/MM/DD.md.
You can also use slashes e.g. foo/bar to create foo/bar.md.
```
## Related
- [jt][jt] - Creates timestamped notes (simplified version of jot)
- [jrnl][jrnl] - Frictionless journaling from the CLI
## License
[MIT][license] © Paul Esch-Laurent.
[jrnl]: https://github.com/Pinjasaur/jrnl
[jt]: https://github.com/Pinjasaur/jt
[license]: https://pinjasaur.mit-license.org/2017
[globstar]: https://www.linuxjournal.com/content/globstar-new-bash-globbing-option