Skip to content

srid/neuron

Repository files navigation

neuron

AGPL built with nix FAIR Matrix Liberapay

neuron is a future-proof app for managing your plain-text notes in Zettelkasten style, as well as for publishing them on the web. Read its philosophy.

Checkout Emanote, neuron's successor! Neuron is being superceded by Emanote: https://github.com/srid/emanote

Highlights

  • Work with a directory of markdown files
  • Powerful linking syntax and hierarchical tagging
  • Auto-generated static web site (see examples)
  • Simple to use, with optional editor integration (emacs, vim, vscode, etc.)

Getting started

See https://neuron.zettel.page/install to install and use neuron locally. Or start from neuron-template if you just want to publish a neuron site using GitHub Pages.

Developing

Development documentation, including instructions to install from source, is available in CONTRIBUTING.md.

Discussions

To discuss and propose ideas, visit the Discussions tab on GitHub. To chat about the project join Matrix.