neuron

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

Features

• Extended Markdown for easy linking between zettels
• Web interface (auto generated static site)
• Graph view of zettels (organic category tree)
• CLI for creating new zettels with automatic ID

Getting started

See neuron.srid.ca for the full guide to installing and using neuron.

Developing

When modifying src/Neuron, use ghcid as instructed as follows to monitor compile errors:

nix-shell --run ghcid

You can test your changes by running it on the ./guide (or any) zettelkasten as follows:

bin/run ./guide rib serve

This command will also automatically recompile and restart when you change any of the Haskell source files.

Running tests

Unit tests can be run via ghcid as follows:

bin/test