{"id":16343238,"url":"https://github.com/fricklerhandwerk/nixdoc-to-github","last_synced_at":"2026-05-08T14:41:48.397Z","repository":{"id":240156909,"uuid":"801828261","full_name":"fricklerhandwerk/nixdoc-to-github","owner":"fricklerhandwerk","description":"Convert nixdoc output to GitHub markdown.","archived":false,"fork":false,"pushed_at":"2024-06-03T10:04:02.000Z","size":12,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-08T04:54:38.424Z","etag":null,"topics":["documentation","github","markdown","nix"],"latest_commit_sha":null,"homepage":"","language":"Nix","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fricklerhandwerk.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-05-17T01:52:33.000Z","updated_at":"2024-06-03T10:04:05.000Z","dependencies_parsed_at":"2024-11-07T07:46:39.217Z","dependency_job_id":"7ac58715-47a6-467d-80fc-c617d280adba","html_url":"https://github.com/fricklerhandwerk/nixdoc-to-github","commit_stats":null,"previous_names":["fricklerhandwerk/nixdoc-to-github"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/fricklerhandwerk/nixdoc-to-github","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fricklerhandwerk%2Fnixdoc-to-github","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fricklerhandwerk%2Fnixdoc-to-github/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fricklerhandwerk%2Fnixdoc-to-github/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fricklerhandwerk%2Fnixdoc-to-github/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fricklerhandwerk","download_url":"https://codeload.github.com/fricklerhandwerk/nixdoc-to-github/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fricklerhandwerk%2Fnixdoc-to-github/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32785386,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-08T08:22:46.396Z","status":"ssl_error","status_checked_at":"2026-05-08T08:22:45.650Z","response_time":54,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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","github","markdown","nix"],"created_at":"2024-10-11T00:23:50.848Z","updated_at":"2026-05-08T14:41:48.360Z","avatar_url":"https://github.com/fricklerhandwerk.png","language":"Nix","funding_links":[],"categories":[],"sub_categories":[],"readme":"# nixdoc to GitHub\nConvert [nixdoc](https://github.com/nix-community/nixdoc/) output to GitHub markdown.\n\nEver wanted to show your Nix language library reference documentation right in the `README.md`?\nThis is how to do it.\n\n\u003e **Example**\n\u003e\n\u003e ## Automatically update files with a pre-commit hook\n\u003e\n\u003e Write a Nix language library with [RFC 145](https://github.com/NixOS/rfcs/pull/145)-style comments:\n\u003e\n\u003e ````nix\n\u003e /**\n\u003e A library to do nothing at all\n\u003e */\n\u003e { lib }:\n\u003e {\n\u003e   /**\n\u003e   This elegantly wraps `pkgs.lib.id`.\n\u003e\n\u003e   :::{.example}\n\u003e\n\u003e   # Do nothing\n\u003e\n\u003e   ```nix\n\u003e   id x\n\u003e   ```\n\u003e   :::\n\u003e   */\n\u003e   id = lib.id;\n\u003e }\n\u003e ````\n\u003e\n\u003e Add [fricklerhandwerk/git-hooks](https://github.com/fricklerhandwerk/git-hooks) to automatically set up Git hooks in your Nix shell environment.\n\u003e\n\u003e ```shell-session\n\u003e nix-shell -p npins\n\u003e npins init\n\u003e npins add github fricklerhandwerk nixdoc-to-github -b main\n\u003e npins add github fricklerhandwerk git-hooks -b main\n\u003e ```\n\u003e\n\u003e Add a pre-commit hook to update `README.md`:\n\u003e\n\u003e ```nix\n\u003e # default.nix\n\u003e {\n\u003e   sources ? import ./npins,\n\u003e   system ? builtins.currentSystem,\n\u003e   pkgs ? import sources.nixpkgs { inherit system; config = { }; overlays = [ ]; },\n\u003e   nixdoc-to-github ? pkgs.callpackage sources.nixdoc-to-github { },\n\u003e   git-hooks ? pkgs.callPackage sources.git-hooks { },\n\u003e }:\n\u003e let\n\u003e   lib = {\n\u003e     inherit (git-hooks.lib) git-hooks;\n\u003e     inherit (nixdoc-to-github.lib) nixdoc-to-github;\n\u003e   };\n\u003e   update-readme = lib.nixdoc-to-github.run {\n\u003e     description = \"Nothing\";\n\u003e     category = \"nothing\";\n\u003e     file = \"${toString ./lib.nix}\";\n\u003e     output = \"${toString ./README.md}\";\n\u003e   };\n\u003e in\n\u003e {\n\u003e   lib.nothing = pkgs.callPackage ./lib.nix { };\n\u003e   shell = pkgs.mkShellNoCC {\n\u003e     shellHook = ''\n\u003e       ${with lib.git-hooks; pre-commit (wrap.abort-on-change update-readme)}\n\u003e     '';\n\u003e   };\n\u003e }\n\u003e ```\n\u003e\n\n## `lib.nixdoc-to-github.run`\n\n- `description` (string)\n\n  Title to be displayed as the first heading in the document.\n\n- `category` (string)\n\n  Top-level attribute name for the library.\n  For example, setting `\"foo\"` will result in headings of the form `lib.foo.some-function`.\n\n- `file` (string)\n\n  Nix file to parse.\n\n- `output` (string)\n\n  File to write the output to.\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffricklerhandwerk%2Fnixdoc-to-github","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffricklerhandwerk%2Fnixdoc-to-github","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffricklerhandwerk%2Fnixdoc-to-github/lists"}