Skip to content

Commit a4a2f70

Browse files
Add README.md
1 parent a9e96f8 commit a4a2f70

1 file changed

Lines changed: 56 additions & 0 deletions

File tree

README.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# hx.raskell.io
2+
3+
Website for [hx](https://github.com/raskell-io/hx) — an extremely fast Haskell package and project manager, written in Rust.
4+
5+
**Live site:** https://hx.raskell.io
6+
7+
## Overview
8+
9+
This repository contains the source for the hx product website. Built with [Zola](https://www.getzola.org/) using the `purple-haze` theme.
10+
11+
## Development
12+
13+
### Prerequisites
14+
15+
- [Zola](https://www.getzola.org/documentation/getting-started/installation/) (0.18+)
16+
- Or use [mise](https://mise.jdx.dev/) to manage the environment:
17+
```bash
18+
mise install
19+
```
20+
21+
### Local Development
22+
23+
```bash
24+
# Start development server with live reload
25+
zola serve
26+
27+
# Build for production
28+
zola build
29+
30+
# Check for errors
31+
zola check
32+
```
33+
34+
The development server runs at `http://127.0.0.1:1111` by default.
35+
36+
## Project Structure
37+
38+
```
39+
.
40+
├── config.toml # Zola configuration
41+
├── content/ # Markdown content pages
42+
├── static/ # Static assets (images, fonts, etc.)
43+
├── templates/ # HTML templates (if overriding theme)
44+
└── themes/
45+
└── purple-haze/ # Custom theme
46+
├── sass/ # SCSS stylesheets
47+
└── templates/ # Theme templates
48+
```
49+
50+
## Deployment
51+
52+
The site is automatically deployed on push to the main branch.
53+
54+
## License
55+
56+
MIT

0 commit comments

Comments
 (0)