Plugins

NixMkDocs' module now includes wrappers/abstractions over some MkDocs plugins.

mkdocs-material

Example:

material = {
  enable = true;
  colors = {
    primary = "indigo"; # mkdocs-material colors
    accent = "blue";
  };
};

For all options see Options.

mkdocs-macros

Example:

macros = {
  enable = true;
  includeDir = ./some_includes;  # directory where "include" will look for files
};

For all options see Options.

mkdocs-material-umami

Example:

material.umami = {
  enable = true;
  src = "https://umami.example.com/umami";
  siteId = "UUID of site";
  domains = ["myproject.example.com"];
};

For all options see Options.

mkdocs-dynamic-nav

Example:

dynamic-nav = {
  enable = true;
  files."Dynamic Nav Plugin" = [
    {"Look im below E!" = builtins.toFile "test.md" "This is generated from Nix and the order works!";}
    {"Example Entry" = builtins.toFile "test.md" "Hello from Nix!";}
  ];
};

For all options see Options.