Note: Emanote documentation is a
work-in-progress
Official method
Emanote is supported on all popular operating systems through Nix.
- Install Nix (for Windows, see Using on Windows or the Docker approach)
-
Optional: Use build cache:
nix-env -if cachix && cachix use srid
-
Run
nix-env -if https://github.com/srid/emanote/archive/refs/heads/master.tar.gz
to install Emanote
To test your Emanote install,
# Run live server (host and port are optional)
cd /path/to/notebook
emanote --host=0.0.0.0 --port=8001
# Generate static files (-L defaults to current directory)
mkdir /tmp/output
emanote -L /path/to/notebook gen /tmp/output
Non-nix methods
If you do not wish to use Nix, you may use Emanote in one of the following ways:
Method | Long-term support | Platforms |
---|---|---|
Docker image | Guaranteed | Linux, WSL, macOS |
Emanote is not on Hackage yet, as 1.0 is yet to be released. Once on Hackage, Emanote can be packaged up in various ways like Pandoc (another Haskell software on Hackage) is. It will become the distributor’s responsibility to create and maintain this long-term. Nix and Docker image are the only mechanisms the author intends to support in the long-term.