clan-core/docs/site/templates/index.md
a-kenji 3d0d124b8a
All checks were successful
checks / checks-impure (pull_request) Successful in 1m52s
checks / checks (pull_request) Successful in 4m21s
documentation: improve templates section
2024-04-14 11:51:43 +02:00

689 B

Templates

We provide some starting templates you can easily use one of those via nix flakes.

They showcase best practices and guide you through setting up and using Clan's modules

I.e. To use the new-clan template run the following command:

nix flake init -t git+https://git.clan.lol/clan/clan-core#new-clan

Available Templates

We offer the following templates:

To initialize a clan with one of those run:

nix flake init -t git+https://git.clan.lol/clan/clan-core#[TEMPLATE_NAME]

Substitute [TEMPLATE_NAME] with the name of the template.

  • new-clan: Perfect for beginners, this template shows you how to link two machines in a basic setup.