Trevor Slocum daef02e637 | ||
---|---|---|
.builds | ||
web | ||
.gitignore | ||
LICENSE | ||
README.md | ||
author.go | ||
branch.go | ||
cli.go | ||
config.go | ||
config_test.go | ||
git.go | ||
go.mod | ||
go.sum | ||
goreleaser.yml | ||
main.go | ||
note.go | ||
notebook.go | ||
platformall.go | ||
platformwin.go | ||
stick.go | ||
utils.go | ||
web.go |
README.md
stick
Shareable Git-backed Markdown-formatted notes
Demo
Note: Read-only except checking/un-checking items.
Install
There are two ways to install stick:
Download
Prebuilt binaries are available here.
Build
GO111MODULE=on go get -u git.sr.ht/~tslocum/stick
Configure
Initialize a notebook by creating an empty git repository:
stick init /home/stick/notes/johnsnotes
Configure stick via ~/.config/stick/stick.yml (or elsewhere by using --config later)
# Used when hashing data (set to a random string)
salt: xXxsh3cr3txXx
# Serve notes on localhost only
# Set to :9991 to serve on all interfaces (not recommended, use a reverse proxy instead)
serve: localhost:9991
# Authors are defined by email and name (used when committing)
authors:
john@hotmail.com: John Doe
jane@aol.com: Jane Doe
# Notebooks can be shared between authors with varying access levels
# When an access level isn't specified, read/write is assumed
# John's notebook allows read/write access to himself and read-only access to Jane
notebooks:
John's notes:
repo: /home/stick/notes/johnsnotes
serve:
- john@hotmail.com
- jane@aol.com: read
Jane's notes:
repo: /home/stick/notes/janesnotes
serve:
- jane@aol.com
- john@hotmail.com: read
Groceries:
repo: /home/stick/notes/groceries
serve:
- john@hotmail.com
- jane@aol.com
Run
stick serve
Annotations
Notes may be annotated to customize their display.
[//]: # (list,sort)
* [ ] Eggs
* [ ] Flour
* [X] Milk
list
Increase text and checkbox size, auto-capitalize items
sort
Sort items alphabetically
Support
Share suggestions/issues here.