jot.run

Jot is a system for quickly publishing authenticated markdown notes, documentation, or other writings. The primary intention is to go from zero to published in seconds.

Install

Download the latest client binary from the releases page and put it somewhere in your PATH.

Quickstart

First, generate a key and give it a workdir, where your files will live.

jot init ~/jot/MyNotes

Create an index markdown file that will dispaly at the root of your home directory.

echo "# Hello, World!" > ~/jot/MyNotes/index.md

Now, upload the file.

jot upload ~/jot/MyNotes/index.md

Your file will now display at your user directory:

https://jot.run/~dedbeef

You can also have the uploads be completely automated.

jot watch ~/jot/MyNotes/

How it works

Keys and users

Every "user" is represented by an ECDSA/secp256k1 encryption keypair. They're mostly referred to by the first 7 hex characters of their public key. For example, this is published by ~470f505.

On upload, the client will cryptographically sign every file and provide that to the server for authentication. All files uploaded are verified by the server using this signature.

Content and rendering

The server will render all markdown into HTML that a browser will display. Other files may also be uploaded that can be used in these markdown files, like images. Servers may restrict what you can upload.

You can also use CSS for your key's directory. Just create a styles.css file in your key's workdir.

echo 'body { background: #ccc; }' > ~/jot/MyNotes/styles.css
jot upload ~/jot/MyNotes/styles.css

Now your markdown pages should render with a grey background.