Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/haskellfoundation/haskellfoundation.github.io

The Haskell Foundation website, hosted by GitHub Pages.
https://github.com/haskellfoundation/haskellfoundation.github.io

cabal haskell haskell-foundation stack

Last synced: about 4 hours ago
JSON representation

The Haskell Foundation website, hosted by GitHub Pages.

Host: GitHub
URL: https://github.com/haskellfoundation/haskellfoundation.github.io
Owner: haskellfoundation
License: other
Created: 2021-03-22T17:05:58.000Z (almost 4 years ago)
Default Branch: hakyll
Last Pushed: 2024-04-22T07:13:26.000Z (9 months ago)
Last Synced: 2024-04-24T03:14:09.671Z (9 months ago)
Topics: cabal, haskell, haskell-foundation, stack
Language: Nix
Homepage: https://haskell.foundation
Size: 28.4 MB
Stars: 38
Watchers: 14
Forks: 39
Open Issues: 25
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

# The Haskell Foundation Website

[![Hackage](https://img.shields.io/static/v1?label=Haskell%20Foundation&message=official&color=purple&style=for-the-badge)](https://haskell.foundation)

This repository is for the [haskell.foundation](https://haskell.foundation) website. It is a proud, Hakyll-based site, built as an in-kind contribution from [Obsidian Systems](https://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](#the-haskell-foundation-website)
- [Table Of Contents](#table-of-contents)
- [Building](#building)
- [CI](#ci)
- [License](#license)

## Building

To build the project:

```bash
stack build
```

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

```bash
stack exec -- site build
```

and for development use:

```bash
stack 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](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.