<p align="center"> <img src="https://haskell.foundation/assets/images/logos/hf-logo-alpha.png" width="350" height="282" alt="Haskell Foundation" title="Haskell Foundation"> </p>

The Haskell Foundation Website

This repository is for the haskell.foundation website. It is a proud, Hakyll-based site, built as an in-kind contribution from Obsidian Systems, and maintained by the Haskell Foundation and its volunteers. If you would like to get started with a merge request, please consult the documentation below.

Table Of Contents

• The Haskell Foundation Website
  • Table Of Contents
  • Building
  • CI
  • License

Building

To build the project:

stack build
# alternatively: cabal build

Once the project has built (which can take a while due to the dependencies for Hakyll), generate the site with:

stack exec -- site build
# alternatively: cabal run -- site build

and for development use:

stack run -- site watch
# alternatively: cabal run -- site watch

The site will be build in the _site directory, and you can open the files in your browser of choice. Due to a Hakyll issue, some sponsor logos will not show up correctly. This is expected behavior, and should be fine for the deployed site.

For further information, please refer to the CONTRIBUTING.md at the root of this project.

CI

We use GitHub Actions .github/workflows/main.yml to build the site for production.

The general steps are:

1. Check out the hakyll branch
2. Install Haskell
3. Restore the cached build artefacts
4. Build the site executable
5. Rebuild the site contents using the site executable
6. Check out the main branch
7. Copy the _site directory over the main branch contents
8. Commit and push the site contents to the main branch.

License

This site is open source, and covered under the Apache 2.0 license.