A minimal project template with docs!

Included Configuration

  • devshell for your contribution environments!
  • treefmt for formatting all the things!
  • mdbook for making documentation part of your workflow!
  • lefthook for commit discipline and a clean history!
  • GitHub Setting App for configuring GitHub declaratively!


# make a new empty project dir
mkdir my-project
cd my-project

# grab the template
nix flake init -t github:divnix/std#minimal

# see which values to change
grep -r --include=\*.nix 'CONFIGURE-ME' .

# do some inititialization
git init && git add .

# enter the devshell and effectuate repo configuration
direnv allow

git add . && git commit -m "feat: initial commit"