https://github.com/srid/neuron

Future-proof note-taking and publishing based on Zettelkasten (superseded by Emanote: https://github.com/srid/emanote)
https://github.com/srid/neuron

blog note-taking static-site zettelkasten

Last synced: about 15 hours ago
JSON representation

Future-proof note-taking and publishing based on Zettelkasten (superseded by Emanote: https://github.com/srid/emanote)

• Host: GitHub
• URL: https://github.com/srid/neuron
• Owner: srid
• License: agpl-3.0
• Created: 2020-03-05T01:29:54.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-05-22T16:29:04.000Z (over 1 year ago)
• Last Synced: 2025-01-18T08:07:08.182Z (8 days ago)
• Topics: blog, note-taking, static-site, zettelkasten
• Language: Haskell
• Homepage: https://neuron.zettel.page
• Size: 28.5 MB
• Stars: 1,519
• Watchers: 35
• Forks: 150
• Open Issues: 25
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• my-awesome - srid/neuron - taking,static-site,zettelkasten pushed_at:2023-05 star:1.5k fork:0.1k Future-proof note-taking and publishing based on Zettelkasten (superseded by Emanote: https://github.com/srid/emanote) (Haskell)
• my-awesome-github-stars - srid/neuron - Future-proof note-taking and publishing based on Zettelkasten (superseded by Emanote: https://github.com/srid/emanote) (Haskell)
• jimsghstars - srid/neuron - Future-proof note-taking and publishing based on Zettelkasten (superseded by Emanote: https://github.com/srid/emanote) (Haskell)
• awesome-starred - srid/neuron - Future-proof note-taking and publishing based on Zettelkasten (superseded by Emanote: https://github.com/srid/emanote) (others)

README

        


# neuron

[![AGPL](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](https://en.wikipedia.org/wiki/Affero_General_Public_License)

[![built with nix](https://img.shields.io/badge/Built_With-Nix-5277C3.svg?logo=nixos&labelColor=73C3D5)](https://builtwithnix.org)

[![FAIR](https://img.shields.io/badge/FAIR-pledge-blue)](https://www.fairforall.org/about/)

[![Matrix](https://img.shields.io/matrix/neuron:matrix.org)](https://app.element.io/#/room/#neuron:matrix.org "Chat on Matrix")

[![Liberapay](https://img.shields.io/liberapay/patrons/srid.svg?logo=liberapay)](https://liberapay.com/srid/donate "Donate using liberapay")

neuron is a **future-proof** app for managing your plain-text notes in [Zettelkasten](https://neuron.zettel.page/zettelkasten) style, as well as for **publishing** them on the web. Read its [philosophy](https://neuron.zettel.page/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](https://neuron.zettel.page/examples))

- Simple to use, with optional editor integration ([emacs, vim, vscode, etc.](https://neuron.zettel.page/editor))

## Getting started

See https://neuron.zettel.page/install to install and use neuron locally. Or start from [neuron-template](https://github.com/srid/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](https://github.com/srid/neuron/blob/master/CONTRIBUTING.md).

## Discussions

To discuss and propose ideas, visit the [Discussions tab](https://github.com/srid/neuron/discussions) on GitHub. To chat about the project join [Matrix](https://app.element.io/#/room/#neuron:matrix.org).