search

srid / emanote

Emanate a structured view of your plain-text notes
https://emanote.srid.ca
Other
772 stars 67 forks source link
ema haskell markdown obsidian-md orgmode pandoc static-site zettelkasten

readme

emanote

AGPL built with nix Matrix Harmeless Code of Conduct

Emanote emanates[^def] a structured view of your plain-text notes.

[^def]: emanate: (of something abstract but perceptible) issue or spread out from (a source)

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.[^licenses] 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

You may want to run nix run github:srid/nixci build before opening a PR, but the CI will run it as well.

Discussion

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

[^licenses]: Emanote uses software and resources that are licensed differently, viz.: