Neuron 1.0 released

Neuron is a note-taking tool based on Zettelkasten, that aims to be future-proof, and is optimized for publishing on the web. Version 1.0 just got released, with better linking support and many other improvements.

Better Linking

Neuron now supports wiki-links, the same syntax used by other software like Zettlr and Obsidian. If your note file is named โ€œneuron-v1.mdโ€, you can link to it using [[neuron-v1]]. Regular Markdown links also now works as they should โ€“ for example, [Neuron v1.0 released](neuron-v1.md) works exactly like the wiki-link syntax in that it will be recognized as a Zettelkasten connection.

Finally, neuron allows arbitrary title in the note filename. For example, you can start writing a note saved in the file Neuron v1.0 released.md, and link to it from other notes as [[Neuron v1.0 released]]. This is called a title ID. The title of the note is automatically inferred from this filename, unless of course you explicitly specify one in the body of the note (which title ID obviates).

Git-like CLI

Previous versions of neuron required you to pass an explicit -d argument when working on multiple notebooks. This is now obviated by adopting a Git-like CLI interface, wherein neuron will treat the current directory as your notebook without a -d argument.

Static binaries

Some users do not wish to install Nix, and they requested static binaries. We now have a static binary 1 for neuron, albeit only for Linux.

Other improvements

Other notable changes include:

  • Inline tags: You can inline your tags in your notes, so writing #foo will automatically tag the note with โ€œfooโ€.
  • Better unicode support: Now filenames are also unicode-aware. You can write in ่ฎก็ฎ—ๆœบ.md and then link to it as [[่ฎก็ฎ—ๆœบ]].
  • Custom JavaScript: Insert custom JavaScript or head HTML in generated site by adding a head.html file to your notebook. Users use this to do anything from using a different Math library (KaTeX) to adding a navigation bar.
  • All backlinks: Backlinks panel now shows all backlinks (including folgezettel)
  • .. and more

See the release notes for a full list of changes.

Cerveau

Cerveau, the web app for neuron, is now officially out of public beta. Since the public beta (announced at Cerveau, a future-proof web app for notes), the following improvements were made:

  • MathJax Live Preview (see below)
  • WikiLink autocomplete (see above)
  • Tag pages
  • Other UX improvements

Future of neuron

Now that version 1.0 is released, I see two major focus-areas for future-proof open source note-taking โ€“ performance & extensibility. Performance is important for especially large Zettelkastens (think - over 50000 notes), and extensibility enables us to keep neuronโ€™s core small and simple, while allowing users to enrich their notebook with interesting features (eg: flash cards, task management, self-tracking, Pandoc filters) without complicating neuron itself.

To achieve this, Iโ€™m working on a new (independent) core for neuron, called ka Project (named after the Egyptian concept) that eventually will supplant rib/shake used currently in neuron. ka uses Functional Reactive Programming to provide a reactive build pipeline 2 specifically geared towards note-taking, as well as plugin mechanism to customize the behaviour of the application at various stages. In addition to being the new core of neuron, ka Project will be an independent app for use, both in the form of web app and GTK+ app; Neuron sponsors get early access to ka Project source code.


Special thanks goes to the recent sponsors, including Chris Gwilliams, Edward Liaw, Joel McCracken, Alessandro Marrella, Randolph Kahle, Sudeep, Eric Moritz.

๐Ÿ’–

If you enjoy using neuron and/or Cerveau, and would like to show your appreciation, you might be interested in the GitHub sponsor goal that will enable the eventual open-sourcing of Cerveau, a full-stack Reflex-FRP app.

Footnotes
1.
The static binaries are built using Nix itself; see Building Static Haskell binaries using Nix.
2.
See this blog post which details using Reflex-FRP as build engine in ghcide.
Links to this page
#blog/neuron