emanote
Emanote renders your Markdown
files as a nice static site with hot reload.
Use nix run to run the live server, and nix build to build the
static site.
See
emanote-template
for an example flake.nix.
Installation
To use these options, add to your flake inputs:
emanote.url = "github:srid/emanote";
and inside the mkFlake:
imports = [
inputs.emanote.flakeModule
];
Run nix flake lock and you're set.
Options
perSystem.emanote.sites.<name>.allowBrokenLinks
perSystem.emanote.sites.<name>.baseUrl
perSystem.emanote.sites.<name>.layers
perSystem.emanote.sites.<name>.layersString
perSystem.emanote.sites.<name>.port
perSystem.emanote.sites.<name>.prettyUrls
perSystem.emanote
Emanote sites config
Type: submodule
Declared by:
perSystem.emanote.package
The emanote package to use.
By default, the ‘emanote’ flake input will be used.
Type: package
Default: "inputs'.emanote.packages.default"
Declared by:
perSystem.emanote.sites
Emanote sites
Type: attribute set of (submodule)
Declared by:
perSystem.emanote.sites.<name>.allowBrokenLinks
Allow broken links in the static site
Type: boolean
Default: false
Declared by:
perSystem.emanote.sites.<name>.baseUrl
Base URL for relative links
Type: string
Default: "Root URL"
Declared by:
perSystem.emanote.sites.<name>.layers
List of directory paths to run Emanote on
Type: list of path
Declared by:
perSystem.emanote.sites.<name>.layersString
Like layers but local (not in Nix store)
Type: list of string
Declared by:
perSystem.emanote.sites.<name>.port
Port to listen on
Type: signed integer
Default: "Random port"
Declared by:
perSystem.emanote.sites.<name>.prettyUrls
Generate links without .html
Type: boolean
Default: false
Declared by: