https://github.com/snowfallorg/frost

Generate documentation for Nix Flakes.
https://github.com/snowfallorg/frost

Last synced: about 2 months ago
JSON representation

Generate documentation for Nix Flakes.

• Host: GitHub
• URL: https://github.com/snowfallorg/frost
• Owner: snowfallorg
• License: other
• Created: 2023-08-18T00:44:00.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-08-22T21:00:39.000Z (over 1 year ago)
• Last Synced: 2024-04-19T19:05:09.300Z (9 months ago)
• Language: JavaScript
• Size: 43 KB
• Stars: 20
• Watchers: 3
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - snowfallorg/frost - Generate documentation for Nix Flakes. (JavaScript)
• awesome-starred - snowfallorg/frost - Generate documentation for Nix Flakes. (JavaScript)

README

        
# Snowfall Frost



	





	





  



> Generate documentation for Nix Flakes.

## Installation

### Nix Profile

You can install this package imperatively with the following command.

```bash

nix profile install github:snowfallorg/frost

```

### Nix Configuration

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

```nix

{

	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.

```nix

{ pkgs }:

{

	environment.systemPackages = with pkgs; [

		snowfallorg.frost

	];

}

```

## Usage

### `frost build`

Build documentation for a given flake.

```bash

frost build github:snowfallorg/cowsay

```