Welcome
What this site is: a read-only web version of my plain-Markdown notebook, shown here with sample notes that double as its docs.
This is the web version of my notebook, which I keep as a folder of plain Markdown files. The real notebook is private, and I read it mostly on my phone. This copy is built from sample notes instead, and those notes are also the documentation, so browsing the site shows how it works.
What's interesting about it
- The files are the source of truth. The site is a read-only view, rebuilt on every push. See Design Decisions.
- No framework. One Node script and a Markdown parser build the whole site in under a second. See Building and Deploying.
- Private by construction. Only files Git tracks are published, and the private version checks its login token itself, so a gap in the setup locks everyone out instead of letting everyone in. See Privacy and Hosting.
- One search, two places. The site and the notebook's command-line tool share one scoring file, so a query ranks the same way in both. See How Search Works.
The guide
- Writing a Note: the front matter every note starts with.
- Links and Backlinks: how notes point to each other.
- Using Tags: tag pages, and pattern tags for ideas that cross topics.
- How Search Works: how results are ranked.
- Recipe Format: a section with its own format and filters.
- Readwise and Other Highlights: saved passages from books, articles, PDFs, and newsletters.
- The Design: Engineering Pad, and everything a note can contain.
- Privacy and Hosting: how the real one stays private.
- Building and Deploying: running it yourself.
- The Notes CLI: the command-line tool that works alongside the site.
- Design Decisions: the choices behind the site, and why.
Shared, not supported
The code is public under the MIT license, free to read, copy, or adapt. I built it for my own notebook, so there's no support, and I don't accept pull requests. It expects sections (recipes, Readwise, and other highlights) that other notebooks won't share.