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
Emanote sites config
Type: submodule
Declared by:
perSystem.emanote.sites
Emanote sites
Type: attribute set of (submodule)
Declared by:
perSystem.emanote.sites.<name>.package
The emanote package to use
Type: package
Default:
"inputs'.emanote.packages.default"
Declared by:
perSystem.emanote.sites.<name>.allowBrokenInternalLinks
Allow broken internal links in the static site
Type: boolean
Default:
false
Declared by:
perSystem.emanote.sites.<name>.basePath
Top-level directory to copy the static site to
Type: string
Default:
"Root path"
Declared by:
perSystem.emanote.sites.<name>.check
Whether to enable flake checks (htmlproofer) for this site
Type: boolean
Default:
true
Declared by:
perSystem.emanote.sites.<name>.extraConfig
Extra configuration to be merged into index.yaml
Type: attribute set
Default:
{ }
Declared by:
perSystem.emanote.sites.<name>.layers
List of layers to use for the site
Type: list of (submodule)
Declared by:
perSystem.emanote.sites.<name>.layers.*.mountPoint
Mount point for the layer
Type: null or string
Default:
null
Declared by:
perSystem.emanote.sites.<name>.layers.*.outputs.layer
Layer spec
Type: string (read only)
Declared by:
perSystem.emanote.sites.<name>.layers.*.outputs.layerString
Layer spec
Type: string (read only)
Declared by:
perSystem.emanote.sites.<name>.layers.*.path
Directory path to notes
Type: absolute path
Declared by:
perSystem.emanote.sites.<name>.layers.*.pathString
Like path but local (not in Nix store)
Type: string
Default: toString path
Declared by:
perSystem.emanote.sites.<name>.outputs.package
The static website package
Type: package (read only)
Declared by:
perSystem.emanote.sites.<name>.outputs.app
The live server app
Type: attribute set (read only)
Declared by:
perSystem.emanote.sites.<name>.outputs.check
Link check for the static website
Type: null or package (read only)
Declared by:
perSystem.emanote.sites.<name>.port
Port to listen on
Type: signed integer
Default:
"Random port"
Declared by: