tjweir / neuron

WIP: Haskell meets Zettelkasten, for your plain-text delight.

neuron

neuron is a system for managing your plain-text Zettelkasten notes.

Features

• Static site generation of notes, for easy browsing
  • Graph-based automatic category tree view
• CLI for creating new zettel
• Exposed Haskell library to build your own system

See ./example/srid.ca for (work in progress) real-world example.

Roadmap

• Nix-based nvim for searching and editing Zettels
• Weblog adapter on top

Prerequisites

First, install the Nix package manager:

bash <(curl https://nixos.org/nix/install)

Optionally, enable the Nix cache if you would like to speed up local builds:

# If you do not already have cachix, install it:
nix-env -iA cachix -f https://cachix.org/api/v1/install
# Enable nix cache for rib
cachix use srid

Running example

To build and run the example:

bin/run-example

Guide

TODO Write a nice guide (using neuron itself) to using neuron, including topics like:

• ZettelID (timestamp based, or custom text)
• Zettel graph and tree filtering
• Zettel link schemes: z://, zcf://
  • Zettel query: zquery://
• zettel CLI to make new zettels