neuron: Haskell meets Zettelkasten, for your plain-text delight.
Modules
[Index] [Quick Jump]
Downloads
- neuron-0.2.0.0.tar.gz [browse] (Cabal source package)
- Package description (as included in the package)
Maintainer's Corner
For package maintainers and hackage trustees
Candidates
| Versions [RSS] | 0.2.0.0, 0.4.0.0, 0.6.0.0, 1.0.0.0 |
|---|---|
| Change log | CHANGELOG.md |
| Dependencies | aeson, algebraic-graphs (>=0.5), base (>=4.7 && <5), clay, containers, dhall (>=1.30), directory, exceptions, file-embed, filepath, filepattern, foldl, gitrev, lucid, mmark, mmark-ext, modern-uri, optparse-applicative, pandoc, path, path-io, relude, rib (>=0.8 && <0.9), shake, text, time, unix, which, with-utf8 [details] |
| License | BSD-3-Clause |
| Copyright | 2020 Sridhar Ratnakumar |
| Author | Sridhar Ratnakumar |
| Maintainer | srid@srid.ca |
| Uploaded | by sridca at 2020-04-08T15:13:54Z |
| Category | Web |
| Home page | https://neuron.srid.ca |
| Bug tracker | https://github.com/srid/neuron/issues |
| Source repo | head: git clone https://github.com/srid/neuron |
| Distributions | |
| Executables | neuron |
| Downloads | 1029 total (15 in the last 30 days) |
| Rating | (no votes yet) [estimated by Bayesian average] |
| Your Rating | |
| Status | Docs uploaded by user Build status unknown [no reports yet] |
Readme for neuron-0.2.0.0
[back to package description]
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