https://github.com/numtide/nixos-facter-docs

Documentation for NixOS Facter and NixOS Facter Modules
https://github.com/numtide/nixos-facter-docs

buildbot-numtide

Last synced: about 2 months ago
JSON representation

Documentation for NixOS Facter and NixOS Facter Modules

• Host: GitHub
• URL: https://github.com/numtide/nixos-facter-docs
• Owner: numtide
• License: cc-by-sa-4.0
• Created: 2024-07-30T12:48:25.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-09-05T14:17:20.000Z (4 months ago)
• Last Synced: 2024-09-05T14:17:39.055Z (4 months ago)
• Topics: buildbot-numtide
• Language: Nix
• Homepage:
• Size: 5.75 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# nixos-facter-docs

This repository contains documentation for [nixos-facter][facter-repo] and [nixos-facter-modules][facter-modules-repo].

## Navigating the documentation

This repository uses [Diátaxis][diataxis] as a framework to organize documentation.

Individual documents are split by content type in `./docs`:

- Explanation

- Tutorial

- How-to

- Reference

## Building the documentation

> [!IMPORTANT]  

> Building the documentation requires your Nix installation to support flakes.

> Consult the [NixOS Wiki page on flakes][enable-flakes] for more information.

1.  Clone this repository.

2.  Change directory to the repository.

3.  Run `nix build`.

The built documentation site is located in `./result`.

## License

The contents of this repository are licensed under the terms of the [Creative Commons Attribution-ShareAlike 4.0 International](./LICENSE.txt) license.

[facter-repo]: https://github.com/numtide/nixos-facter

[facter-modules-repo]: https://github.com/numtide/nixos-facter-modules

[diataxis]: https://diataxis.fr/

[enable-flakes]: https://nixos-and-flakes.thiscute.world/nixos-with-flakes/nixos-with-flakes-enabled#enable-nix-flakes