Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bwasti/jott
A simple way to jot down notes
https://github.com/bwasti/jott
Last synced: 14 days ago
JSON representation
A simple way to jot down notes
- Host: GitHub
- URL: https://github.com/bwasti/jott
- Owner: bwasti
- Created: 2018-09-02T23:51:06.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2018-09-28T06:52:40.000Z (about 6 years ago)
- Last Synced: 2024-08-01T16:44:44.015Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 763 KB
- Stars: 111
- Watchers: 4
- Forks: 8
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# jott
A minimal tool for quickly writing and sharing notes. Check out https://jott.live for a demo.
### Command line
Use `curl` directly for quick uploading.
```
$ echo "test" | curl -F 'note=<-' https://jott.live/save/raw//
```
Alternatively, the `jott` script in `jott/scripts` makes it easier to upload and read notes.
To install the script without downloading the repo:
```
$ curl https://jott.live/raw/note/note_script > jott.sh && chmod +x jott.sh && alias jott='./jott.sh'
```
Upload a note by piping through `stdin`, `jott [note name] [password]`
```
$ echo "this is a test" | jott my_test_note secret_password
Success! Note "my_test_note" saved
```
Download a note with `jott [note name]`
```
$ jott my_test_note
this is a test
```
Delete a note with `jott -d [note name] [password]`
```
$ jott -d my_test_note secret_password
Success! Note "my_test_note" deleted
```
### Website
- `/edit/note/` will create a blank note.
- `/edit/note/` will edit an existing note.
- `/note/` will return the default HTML rendering of the note.
- `/raw/` will return the note as raw text. (Useful with wget/curl.)
- `/texdown/` will return a minimal [TeXDown](https://github.com/tex-ninja/texdown#texdown) rendering of the note. [Example](https://jott.live/texdown/note/test)
- `/code/` will syntax highlight the note.
- `/edit/note/` will open a basic editor for the note.
## Installation
Although you can use https://jott.live to test out this project, do not rely on it for anything important.
If you find this useful, I'd recommend hosting your own instance. It is quite lightweight.
Requirements:
- flask (`pip install flask`)
Run the server with
```
FLASK_ENV=prod python3 main.py
```