srid / emanote

Emanate a structured view of your plain-text notes

emanote

Emanote emanates¹ a structured view of your plain-text notes.

Create beautiful websites -- such as personal webpage, blog, wiki, Zettelkasten, notebook, knowledge-base, documentation, etc. from future-proof plain-text notes and arbitrary data -- with live preview that updates in real-time.

Emanote is spiritual successor to neuron based on Ema.

Installing and using

https://emanote.srid.ca/start/install

Examples

https://emanote.srid.ca/examples

Developing

Emanote is a Haskell software.² Thanks to Nix, this repository is pre-configured to provide a delightful development experience with full IDE support in Visual Studio Code.

See https://srid.ca/haskell-template/start for complete instructions, but briefly: Install Nix and run nix develop -c just run.

See architecture for a high-level overview of the codebase.

PR contribution guidelines

Run nix run nixpkgs#nixci before opening a PR.

Discussion

To discuss the emanote project, join Matrix or post in GitHub Discussions.

Footnotes

1. emanate: (of something abstract but perceptible) issue or spread out from (a source) ↩

2. Emanote uses software and resources that are licensed differently, viz.:

   • Logo
   • Stork search
   • Tailwind CSS
   • Various SVG icons are from Heroicons
   ↩