https://github.com/gvolpe/nmd

NixOS Module Documentation generator
https://github.com/gvolpe/nmd

documentation documentation-generator nix nixos

Last synced: 13 days ago
JSON representation

NixOS Module Documentation generator

• Host: GitHub
• URL: https://github.com/gvolpe/nmd
• Owner: gvolpe
• License: mit
• Created: 2022-12-27T18:04:12.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2022-12-28T15:07:25.000Z (almost 2 years ago)
• Last Synced: 2024-10-11T23:45:41.866Z (30 days ago)
• Topics: documentation, documentation-generator, nix, nixos
• Language: Nix
• Homepage:
• Size: 29.3 KB
• Stars: 16
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# nmd

Fork of [rycee/nmd](https://gitlab.com/rycee/nmd/) with theming options and flakes support.

## Usage

Add flake input.

```nix

{

  inputs = {

    nixpkgs.url = github:nixos/nixpkgs/nixpkgs-unstable;

    nmd.url = github:gvolpe/nmd;

  };

}

```

Add overlay.

```nix

{

  pkgs = import nixpkgs {

    inherit system;

    overlays = [ inputs.nmd.overlays.default ];

  };

}

```

Use the functions provided in the `pkgs.nmd` set, e.g.

```nix

{

  docs = pkgs.nmd.buildDocBookDocs {

    pathName = "super-cool-flake";

    projectName = "My super cool project";

    modulesDocs = [ modulesDocs ];

    documentsDirectory = ./.;

    documentType = "book";

    theme = "night-owl";

  };

}

```

Rendered example: [gvolpe.com/neovim-flake](https://gvolpe.com/neovim-flake/).