3 ms·
Neuron [1] is an exciting new Zettelkasten project. In short, it’s a CLI tool that transforms a directory of markdown files with some special syntax into a sta
by maddyboo 6y ago
Neuron [1] is an exciting new Zettelkasten project.
In short, it’s a CLI tool that transforms a directory of markdown files with some special syntax into a static site.
A couple of highlights: It’s got support for tags, links, backlinks; it can generate trees of links to notes matching a given tag; the static site has search functionality; there are editor plugins for vim and Emacs.
The CLI has the ability to output your entire Zettelkasten graph as JSON, which you can then parse and use to write scripts. I’ve already used this feature to write a few tools for myself that greatly improve my note taking workflow.
Behind the scenes, Neuron uses Pandoc to convert the markdown into HTML. There is talk of a feature that would allow the user to write Pandoc filters which would essentially be programs that transform the Neuron AST prior to it being rendered with Pandoc. Such a feature would open up tons of opportunities for customization, e.g. you could write rules to parse custom syntax in your markdown files and generate inline HTML. I’ve already written a tool that does something similar [2] without the use of a Pandoc filter by operating directly on the generated HTML files, but a Pandoc filter would greatly improve the process.
All of your notes are simply markdown files stored on your local machine, so you’re free to do whatever you’d like with them: store them in git, write scripts to generate them, whatever.
The author is simultaneously developing Cerveau [3] which is a hosted web interface that allows you to edit your notes remotely via a web browser. It transparently syncs your edits to a GitHub repository. Unfortunately, Cerveau is currently closed source, but I believe the author has expressed interest in opening it up if he’s able to get enough GitHub sponsors to sustain its development.
If it matters to you, Neuron is written in Haskell and the project makes heavy use of Nix.
1: https://github.com/srid/neuron https://github.com/srid/neuron
2: https://github.com/srid/neuron/issues/228#issuecomment-670290253 https://github.com/srid/neuron/issues/228#issuecomment-67029...
3: https://www.cerveau.app https://www.cerveau.app
- bergie 6y agoSounds like that would work pretty well with this mobile markdown-based notes app I'm using: https://gitjournal.io/ https://gitjournal.io/