Shareable Git-powered notebooks
Go to file
Trevor Slocum 1558ac096d Update dependencies 2019-08-14 06:16:44 -07:00
.builds Add initial note serving 2019-03-14 00:50:13 -07:00
web Update dependencies 2019-08-14 06:16:44 -07:00
.gitignore Resolve issues using empty notebooks 2019-04-18 04:37:56 -07:00
CHANGELOG Update dependencies 2019-08-14 06:16:44 -07:00
LICENSE Relicense as MIT 2019-06-25 08:29:13 -07:00
README.md Shade list items 2019-08-14 05:58:56 -07:00
author.go Update README 2019-04-16 18:18:59 -07:00
branch.go Add checkHandler 2019-03-20 18:02:10 -07:00
cli.go Use rice to embed static assets 2019-03-13 22:58:51 -07:00
config.go Add Config test 2019-04-16 05:48:32 -07:00
config_test.go Improve login process 2019-04-17 04:17:28 -07:00
git.go Use rice to embed static assets 2019-03-13 22:58:51 -07:00
go.mod Update dependencies 2019-08-14 06:16:44 -07:00
go.sum Update dependencies 2019-08-14 06:16:44 -07:00
goreleaser.yml Resolve issues using empty notebooks 2019-04-18 04:37:56 -07:00
main.go Resolve issues using empty notebooks 2019-04-18 04:37:56 -07:00
note.go web: Add pinned notes 2019-08-11 10:34:16 -07:00
notebook.go Improve note editing 2019-04-23 06:10:05 -07:00
platformall.go Resolve issues using empty notebooks 2019-04-18 04:37:56 -07:00
platformwin.go Resolve issues using empty notebooks 2019-04-18 04:37:56 -07:00
stick.go Resolve issues using empty notebooks 2019-04-18 04:37:56 -07:00
utils.go Add sort annotation, auto-capitalize list items 2019-04-19 07:01:03 -07:00
web.go web: Add pinned notes 2019-08-11 10:34:16 -07:00

README.md

stick

GoDoc builds.sr.ht status Donate

Shareable Git-backed Markdown-formatted notes

Demo

Try stick

Note: Read-only except checking/un-checking items.

Install

Choose one of the following methods:

Download

Download stick (Windows and Linux binaries are available)

Compile

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

  Shared notes:
    repo: /home/stick/notes/shared
    serve:
      - john@hotmail.com
      - jane@aol.com

Run

stick serve

Options

Note display and behavior can be customized via the options directive:

[//]: # (list,sort)

* [ ] Eggs
* [ ] Flour
* [X] Milk

This directive must be the first line of the note. When using the web interface to change note options, this directive will be added and updated automatically.

The following options are available:

Pin

Pinned notes will appear in another notebook labeled "Pinned"

List

Emphasize and remove duplicate list items

Sort

Sort list items alphabetically

Dismissed

Show dismissed list items

Support

Please share suggestions/issues here.