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

[ agpl, library, program, web ] [ Propose Tags ]

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

[Skip to Readme]

Modules

[Last Documentation]

Data
- Graph
  - Data.Graph.Labelled
    - Data.Graph.Labelled.Algorithm
    - Data.Graph.Labelled.Build
    - Data.Graph.Labelled.Type
- Data.PathTree
- Data.TagTree
Neuron
- Zettelkasten
  - Neuron.Zettelkasten.ID
  - Neuron.Zettelkasten.Zettel
    - Neuron.Zettelkasten.Zettel.Meta
Text
- Megaparsec
  - Text.Megaparsec.Simple

Flags

Manual Flags

Name	Description	Default
ghcid		Disabled

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

neuron-0.4.0.0.tar.gz [browse] (Cabal source package)
Package description (as included in the package)

Maintainer's Corner

Package maintainers

sridca

For package maintainers and hackage trustees

edit package information

Candidates

0.2.0.0, 0.4.0.0, 0.6.0.0, 1.0.0.0

Versions [RSS]	0.2.0.0, 0.4.0.0, 0.6.0.0, 1.0.0.0
Change log	CHANGELOG.md
Dependencies	aeson, aeson-gadt-th, algebraic-graphs (>=0.5), base (>=4.12 && <4.14), clay, containers, data-default, dependent-sum, dependent-sum-template, dhall (>=1.30), directory, exceptions, file-embed, filepath, filepattern, foldl, gitrev, lucid, megaparsec (>=8.0), mmark, mmark-ext, modern-uri, mtl, optparse-applicative, pandoc, parser-combinators, relude, rib (>=0.10 && <0.11), shake, text, time, unix, uuid, which, with-utf8 [details]
License	BSD-3-Clause
Copyright	2020 Sridhar Ratnakumar
Author	Sridhar Ratnakumar
Maintainer	srid@srid.ca
Category	Web
Home page	https://neuron.zettel.page
Bug tracker	https://github.com/srid/neuron/issues
Source repo	head: git clone https://github.com/srid/neuron
Uploaded	by sridca at 2020-05-09T16:01:39Z
Distributions
Executables	neuron
Downloads	821 total (13 in the last 30 days)
Rating	(no votes yet) [estimated by Bayesian average]
Your Rating	λ λ λ
Status	Docs not available [build log] All reported builds failed as of 2020-05-09 [all 2 reports]

Readme for neuron-0.4.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.zettel.page 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 -d ./guide rib -wS

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