GitHub - pbar1/nix-mdbook: Nix library flake for building mdBook projects

nix-mdbook

Nix library flake for building mdBook projects.

Quickstart

Create a new flake in the current directory using the simple template in this repo:

nix flake init -t github:pbar1/nix-mdbook#simple

For a slightly more complex example - using mdBook plugins like mdbook-graphviz - create a new flake using the with-plugin template:

nix flake init -t github:pbar1/nix-mdbook#with-plugin

Then, build the book. The Nix store output in result/ is the contents of the built book/ directory (ie, the compiled book itself):

GitHub Actions & Pages

The with-plugin example from above is built using GitHub Actions and deployed to GitHub Pages as a test.

• Demo site
• GitHub Actions workflow

Usage

Flake

{
  inputs.mdbook.url = "github:pbar1/nix-mdbook";
  outputs =
    { mdbook, ... }:
    let
      system = "x86_64-linux";
    in
    {
      packages = rec {
        book = mdbook.lib.buildMdBookProject {
          inherit system;
          src = ./.;
        };
        default = book;
      };
    };
}

mdbook.lib.buildMdBookProject