{"id":13837865,"url":"https://github.com/gvolpe/nmd","last_synced_at":"2025-08-09T02:05:40.889Z","repository":{"id":147505045,"uuid":"582733389","full_name":"gvolpe/nmd","owner":"gvolpe","description":"NixOS Module Documentation generator","archived":false,"fork":false,"pushed_at":"2022-12-28T15:07:25.000Z","size":30,"stargazers_count":16,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-17T18:13:04.449Z","etag":null,"topics":["documentation","documentation-generator","nix","nixos"],"latest_commit_sha":null,"homepage":"","language":"Nix","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gvolpe.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2022-12-27T18:04:12.000Z","updated_at":"2024-08-22T00:04:20.000Z","dependencies_parsed_at":"2023-05-03T02:49:44.486Z","dependency_job_id":null,"html_url":"https://github.com/gvolpe/nmd","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gvolpe%2Fnmd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gvolpe%2Fnmd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gvolpe%2Fnmd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gvolpe%2Fnmd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gvolpe","download_url":"https://codeload.github.com/gvolpe/nmd/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245036127,"owners_count":20550662,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","documentation-generator","nix","nixos"],"created_at":"2024-08-04T15:01:28.636Z","updated_at":"2025-03-22T23:32:26.853Z","avatar_url":"https://github.com/gvolpe.png","language":"Nix","funding_links":[],"categories":["Nix"],"sub_categories":[],"readme":"# nmd\n\nFork of [rycee/nmd](https://gitlab.com/rycee/nmd/) with theming options and flakes support.\n\n## Usage\n\nAdd flake input.\n\n```nix\n{\n  inputs = {\n    nixpkgs.url = github:nixos/nixpkgs/nixpkgs-unstable;\n    nmd.url = github:gvolpe/nmd;\n  };\n}\n```\n\nAdd overlay.\n\n```nix\n{\n  pkgs = import nixpkgs {\n    inherit system;\n    overlays = [ inputs.nmd.overlays.default ];\n  };\n}\n```\n\nUse the functions provided in the `pkgs.nmd` set, e.g.\n\n```nix\n{\n  docs = pkgs.nmd.buildDocBookDocs {\n    pathName = \"super-cool-flake\";\n    projectName = \"My super cool project\";\n    modulesDocs = [ modulesDocs ];\n    documentsDirectory = ./.;\n    documentType = \"book\";\n    theme = \"night-owl\";\n  };\n}\n```\n\nRendered example: [gvolpe.com/neovim-flake](https://gvolpe.com/neovim-flake/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgvolpe%2Fnmd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgvolpe%2Fnmd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgvolpe%2Fnmd/lists"}