website/README.md

42 lines
883 B
Markdown

<div align="center">
<img width="80px" alt="Hostea logo" src="./static/tmp-logo.png" />
<h1>Hostea Website</h1>
[![status-badge](https://woodpecker.hostea.org/api/badges/Hostea/website/status.svg)](https://woodpecker.hostea.org/Hostea/website)
[![AGPL License](https://img.shields.io/badge/license-AGPL-blue.svg?style=flat-square)](http://www.gnu.org/licenses/agpl-3.0)
</div>
## Development environment
This website uses [Zola](https://www.getzola.org/), an easy to use static site generator.
To get started:
1. Install Zola:
```bash
Make env
```
2. Live reload
```bash
make serve
```
3. Make changes and publish
```bash
make
```
Build artifacts should be available in `./public/`
## Deployment
This repository uses [Hostea
Woodpecker-CI](https://woodpecker.hostea.org/) to build and
[Hostea/Pages](https://gitea.hostea.org/Hostea/pages) to deploy on each
commit.