2020-09-23 02:59:56 +02:00
|
|
|
# hakyll-nix-template
|
2020-09-22 04:03:52 +02:00
|
|
|
|
|
|
|
|
[](https://builtwithnix.org)
|
|
|
|
|
|
2020-09-23 02:59:56 +02:00
|
|
|
[Hakyll](https://jaspervdj.be/hakyll/) + [Nix](https://nixos.org/) template
|
2020-09-23 03:55:39 +02:00
|
|
|
|
|
|
|
|
## Features
|
|
|
|
|
tl;dr: `nix-build` will collect all your pinned dependencies, build your hakyll
|
|
|
|
|
site, and output the built site in a `result/` directory. If you set up the
|
|
|
|
|
[main GitHub Action](./.github/workflows/main.yml) with what it needs (your
|
|
|
|
|
[cachix](https://cachix.org) cache, and your app needs a `CACHIX_SIGNING_KEY`
|
|
|
|
|
secret), it will deploy your built site to a `gh-pages` branch.
|
|
|
|
|
|
|
|
|
|
* Hakyll (see [the generator folder](./generator))
|
|
|
|
|
* Haskell `nix-shell` environment inside the `generator` folder through which
|
|
|
|
|
you can run `hakyll-site watch` and all other hakyll commands, including
|
|
|
|
|
the ability to run `ghci` and load haskell modules for testing
|
|
|
|
|
* Ability to patch hakyll via `hakyll.patch`
|
|
|
|
|
* Ability to provide nixpkgs overrides for packages whose versions need to
|
|
|
|
|
come from [hackage](https://hackage.haskell.org)
|
|
|
|
|
* RSS & Atom XML feed generation
|
|
|
|
|
* Sitemap generation
|
|
|
|
|
* Reasonable pandoc markdown customization to make it as close to GitHub's
|
|
|
|
|
style as possible
|
|
|
|
|
* `Slug.hs` module that makes nice URIs
|
|
|
|
|
* Many other opinionated general website setup features that should be very
|
|
|
|
|
helpful
|
|
|
|
|
* Nix
|
|
|
|
|
* Pinned [nixpkgs](https://github.com/NixOS/nixpkgs), [niv](https://github.com/nmattia/niv),
|
|
|
|
|
and [pre-commit-hooks.nix](https://github.com/cachix/pre-commit-hooks.nix)
|
|
|
|
|
* `nix-build` will build your site into a `result/` directory
|
|
|
|
|
* `nix-shell` in the root will give you a shell with the `tools` dependencies
|
|
|
|
|
in [./nix/default.nix](./nix/default.nix)
|
|
|
|
|
* `nix-shell` in [./generator](./generator) will give you a haskell shell with
|
|
|
|
|
your `hakyll-site` available, as well as `ghci`
|
|
|
|
|
* Dev linting via [pre-commit-hooks.nix](https://github.com/cachix/pre-commit-hooks.nix)
|
|
|
|
|
* [nix-linter](https://github.com/Synthetica9/nix-linter)
|
|
|
|
|
* [nixpkgs-fmt](https://github.com/nix-community/nixpkgs-fmt)
|
|
|
|
|
* [ormolu](https://github.com/tweag/ormolu)
|
|
|
|
|
* [shellcheck](https://github.com/koalaman/shellcheck)
|
|
|
|
|
* Encourages dev use of [lorri](https://github.com/target/lorri)
|
|
|
|
|
* Deployment through a [GitHub Actions](https://github.com/features/actions)
|
|
|
|
|
build with [cachix](https://cachix.org) and deploying to
|
|
|
|
|
[GitHub Pages](https://pages.github.com/) via a `gh-pages` branch
|
