{"id":18980704,"url":"https://github.com/snowfallorg/frost","last_synced_at":"2025-08-18T12:05:58.226Z","repository":{"id":189045196,"uuid":"679933162","full_name":"snowfallorg/frost","owner":"snowfallorg","description":"Generate documentation for Nix Flakes.","archived":false,"fork":false,"pushed_at":"2023-08-22T21:00:39.000Z","size":44,"stargazers_count":28,"open_issues_count":4,"forks_count":1,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-03-29T12:11:14.478Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/snowfallorg.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}},"created_at":"2023-08-18T00:44:00.000Z","updated_at":"2025-02-05T04:03:46.000Z","dependencies_parsed_at":"2023-08-18T03:28:09.842Z","dependency_job_id":null,"html_url":"https://github.com/snowfallorg/frost","commit_stats":null,"previous_names":["snowfallorg/frost"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snowfallorg%2Ffrost","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snowfallorg%2Ffrost/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snowfallorg%2Ffrost/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snowfallorg%2Ffrost/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/snowfallorg","download_url":"https://codeload.github.com/snowfallorg/frost/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249239344,"owners_count":21235852,"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":[],"created_at":"2024-11-08T16:07:33.537Z","updated_at":"2025-04-16T12:31:12.563Z","avatar_url":"https://github.com/snowfallorg.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# Snowfall Frost\n\n\u003ca href=\"https://nixos.wiki/wiki/Flakes\" target=\"_blank\"\u003e\n\t\u003cimg alt=\"Nix Flakes Ready\" src=\"https://img.shields.io/static/v1?logo=nixos\u0026logoColor=d8dee9\u0026label=Nix%20Flakes\u0026labelColor=5e81ac\u0026message=Ready\u0026color=d8dee9\u0026style=for-the-badge\"\u003e\n\u003c/a\u003e\n\u003ca href=\"https://github.com/snowfallorg/lib\" target=\"_blank\"\u003e\n\t\u003cimg alt=\"Built With Snowfall\" src=\"https://img.shields.io/static/v1?label=Built%20With\u0026labelColor=5e81ac\u0026message=Snowfall\u0026color=d8dee9\u0026style=for-the-badge\"\u003e\n\u003c/a\u003e\n\n\u003cp\u003e\n\u003c!--\n\tThis paragraph is not empty, it contains an em space (UTF-8 8195) on the next line in order\n\tto create a gap in the page.\n--\u003e\n  \n\u003c/p\u003e\n\n\u003e Generate documentation for Nix Flakes.\n\n## Installation\n\n### Nix Profile\n\nYou can install this package imperatively with the following command.\n\n```bash\nnix profile install github:snowfallorg/frost\n```\n\n### Nix Configuration\n\nYou can install this package by adding it as an input to your Nix Flake.\n\n```nix\n{\n\tdescription = \"My system flake\";\n\n\tinputs = {\n\t\tnixpkgs.url = \"github:nixos/nixpkgs/nixos-23.05\";\n\t\tunstable.url = \"github:nixos/nixpkgs/nixos-unstable\";\n\n\t\t# Snowfall Lib is not required, but will make configuration easier for you.\n\t\tsnowfall-lib = {\n\t\t\turl = \"github:snowfallorg/lib\";\n\t\t\tinputs.nixpkgs.follows = \"nixpkgs\";\n\t\t};\n\n\t\tsnowfall-frost = {\n\t\t\turl = \"github:snowfallorg/frost\";\n\t\t\tinputs.nixpkgs.follows = \"nixpkgs\";\n\t\t};\n\t};\n\n\toutputs = inputs:\n\t\tinputs.snowfall-lib.mkFlake {\n\t\t\tinherit inputs;\n\t\t\tsrc = ./.;\n\n\t\t\toverlays = with inputs; [\n\t\t\t\t# Use the default overlay provided by this flake.\n\t\t\t\tsnowfall-frost.overlays.default\n\n\t\t\t\t# There is also a named overlay, though the output is the same.\n\t\t\t\tsnowfall-frost.overlays.\"package/frost\"\n\t\t\t];\n\t\t};\n}\n```\n\nIf you've added the overlay from this flake, then in your system configuration you\ncan add the `snowfallorg.frost` package.\n\n```nix\n{ pkgs }:\n\n{\n\tenvironment.systemPackages = with pkgs; [\n\t\tsnowfallorg.frost\n\t];\n}\n```\n\n## Usage\n\n### `frost build`\n\nBuild documentation for a given flake.\n\n```bash\n\nfrost build github:snowfallorg/cowsay\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsnowfallorg%2Ffrost","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsnowfallorg%2Ffrost","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsnowfallorg%2Ffrost/lists"}