8000 GitHub - snowfallorg/frost: Generate documentation for Nix Flakes.
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

snowfallorg/frost

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Snowfall Frost

Nix Flakes Ready Built With Snowfall

  

Generate documentation for Nix Flakes.

Installation

Nix Profile

You can install this package imperatively with the following command.

nix profile install github:snowfallorg/frost

Nix Configuration

You can install this package by adding it as an input to your Nix Flake.

{
	description = "My system flake";

	inputs = {
		nixpkgs.url = "github:nixos/nixpkgs/nixos-23.05";
		unstable.url = "github:nixos/nixpkgs/nixos-unstable";

		# Snowfall Lib is not required, but will make configuration easier for you.
		snowfall-lib = {
			url = "github:snowfallorg/lib";
			inputs.nixpkgs.follows = "nixpkgs";
		};

		snowfall-frost = {
			url = "github:snowfallorg/frost";
			inputs.nixpkgs.follows = "nixpkgs";
		};
	};

	outputs = inputs:
		inputs.snowfall-lib.mkFlake {
			inherit inputs;
			src = ./.;

			overlays = with inputs; [
				# Use the default overlay provided by this flake.
				snowfall-frost.overlays.default

				# There is also a named overlay, though the output is the same.
				snowfall-frost.overlays."package/frost"
			];
		};
}

If you've added the overlay from this flake, then in your system configuration you can add the snowfallorg.frost package.

{ pkgs }:

{
	environment.systemPackages = with pkgs; [
		snowfallorg.frost
	];
}

Usage

frost build

Build documentation for a given flake.

frost build github:snowfallorg/cowsay

About

Generate documentation for Nix Flakes.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published
0