Quick start
You have repositories full of Markdown - notes, docs, decisions that deserve better than a file tree. In five minutes they become one quiet, readable place: yours to write, your team's to read, your agents' to work in.
Pre-release note: the code ships soon as one clean release. This page is exactly what day one looks like.
The five minutes
git clone https://github.com/gethanji/hanji && cd hanji
pnpm install
pnpm dev:web # → http://localhost:4100
The first visit greets you with a short welcome: name the place, choose your password, and point it at your first pages - a folder of Markdown on your machine, or a git URL to clone. That is the whole setup. No environment variables, nothing to configure by hand. (Prefer configuring by env, for a server? Install Hanji keeps that path.)
Then your notes are there, rendered on warm paper. Click Edit, change something, press Update - you just made a clean git commit without thinking about git once. That is the whole trick, and it never gets more complicated than that.
Where to next
Pick the shape that matches your life:
- A team on your tailnet - share one instance where the network signs people in and nobody types a password. On your tailnet.
- Your coding agents - give them scoped reads and let their edits arrive as proposals you review. Agents.
- A public site - one command turns everything you've opened into a
website,
llms.txtincluded. Publish to the web. - Just curious how it holds together? Mounts, then Reading and writing - the two pages that explain the daily feel.