Skip to content
forked from srid/emanote

Spiritual successor to neuron, based on Ema.

License

Notifications You must be signed in to change notification settings

maralorn/emanote

 
 

Repository files navigation

emanote

AGPL built with nix FAIR Matrix Liberapay

Spiritual successor to neuron, based on Ema.

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.

Project Status: In beta phase, but is nearly 1.0.

Installing and using

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

Examples

https://emanote.srid.ca/examples

Developing

Emanote is written in Haskell. Thanks to Nix, this repository is pre-configured to provide a delightful development experience with full IDE support in Visual Studio Code. Follow these steps:

  • Install Nix & enable Flakes
  • Run nix-shell --run haskell-language-server to sanity check your environment (Expect it to download and build a bunch of things the first time)
  • Open the repository as single-folder workspace in Visual Studio Code
    • Install the workspace recommended extensions
    • Ctrl+Shift+P to run command "Nix-Env: Select Environment" and select shell.nix. The extension will ask you to reload VSCode at the end.
  • Press Ctrl+Shift+B in VSCode, or run bin/run (bin/run-via-tmux if you have tmux installed) in terminal, to launch the dev version Emanote on ./docs, then navigate to http://localhost:9010/
    • Changing the Haskell sources will recompile and reload this instance automatically.

All but the final step need to be done only once. See architecture.md for a high-level overview of the codebase.

Discussion

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

About

Spiritual successor to neuron, based on Ema.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Haskell 78.8%
  • HTML 15.0%
  • Nix 4.7%
  • CSS 1.2%
  • Shell 0.3%