Skip to content

Commit 12edf6d

Browse files
committed
feat: Add metadata for Hugo, add workflow and update README with screenshots
Signed-off-by: Felicitas Pojtinger <felicitas@pojtinger.com>
1 parent c306b80 commit 12edf6d

14 files changed

Lines changed: 220 additions & 14543 deletions

File tree

.github/workflows/hugo.yaml

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
# Based on https://gohugo.io/host-and-deploy/host-on-github-pages/#article
2+
3+
name: Hugo CI
4+
on:
5+
push:
6+
branches:
7+
- main
8+
workflow_dispatch:
9+
permissions:
10+
contents: read
11+
pages: write
12+
id-token: write
13+
concurrency:
14+
group: pages
15+
cancel-in-progress: false
16+
defaults:
17+
run:
18+
shell: bash
19+
jobs:
20+
build:
21+
runs-on: ubuntu-latest
22+
env:
23+
DART_SASS_VERSION: 1.98.0
24+
HUGO_VERSION: 0.158.0
25+
NODE_VERSION: 24.14.0
26+
steps:
27+
- name: Checkout
28+
uses: actions/checkout@v6
29+
with:
30+
fetch-depth: 0
31+
- name: Setup Node.js
32+
uses: actions/setup-node@v6
33+
with:
34+
node-version: ${{ env.NODE_VERSION }}
35+
- name: Setup Pages
36+
id: pages
37+
uses: actions/configure-pages@v5
38+
- name: Create directory for user-specific executable files
39+
run: |
40+
mkdir -p "${HOME}/.local"
41+
- name: Install Dart Sass
42+
run: |
43+
curl -sLJO "https://github.com/sass/dart-sass/releases/download/${DART_SASS_VERSION}/dart-sass-${DART_SASS_VERSION}-linux-x64.tar.gz"
44+
tar -C "${HOME}/.local" -xf "dart-sass-${DART_SASS_VERSION}-linux-x64.tar.gz"
45+
rm "dart-sass-${DART_SASS_VERSION}-linux-x64.tar.gz"
46+
echo "${HOME}/.local/dart-sass" >> "${GITHUB_PATH}"
47+
- name: Install Hugo
48+
run: |
49+
curl -sLJO "https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.tar.gz"
50+
mkdir "${HOME}/.local/hugo"
51+
tar -C "${HOME}/.local/hugo" -xf "hugo_extended_${HUGO_VERSION}_linux-amd64.tar.gz"
52+
rm "hugo_extended_${HUGO_VERSION}_linux-amd64.tar.gz"
53+
echo "${HOME}/.local/hugo" >> "${GITHUB_PATH}"
54+
- name: Install Node.js dependencies
55+
run: |
56+
[[ -f package-lock.json || -f npm-shrinkwrap.json ]] && npm ci || true
57+
- name: Cache restore
58+
id: cache-restore
59+
uses: actions/cache/restore@v5
60+
with:
61+
path: ${{ runner.temp }}/hugo_cache
62+
key: hugo-${{ github.run_id }}
63+
restore-keys: hugo-
64+
- name: Build the site
65+
run: |
66+
hugo build \
67+
--gc \
68+
--minify \
69+
--baseURL "${{ steps.pages.outputs.base_url }}/" \
70+
--cacheDir "${{ runner.temp }}/hugo_cache"
71+
- name: Cache save
72+
id: cache-save
73+
uses: actions/cache/save@v5
74+
with:
75+
path: ${{ runner.temp }}/hugo_cache
76+
key: ${{ steps.cache-restore.outputs.cache-primary-key }}
77+
- name: Upload artifact
78+
uses: actions/upload-pages-artifact@v3
79+
with:
80+
path: ./public
81+
deploy:
82+
environment:
83+
name: github-pages
84+
url: ${{ steps.deployment.outputs.page_url }}
85+
runs-on: ubuntu-latest
86+
needs: build
87+
steps:
88+
- name: Deploy to GitHub Pages
89+
id: deployment
90+
uses: actions/deploy-pages@v4

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
public/
2+
resources/
3+
.hugo_build.lock
4+
node_modules/

CNAME

Lines changed: 0 additions & 1 deletion
This file was deleted.

README.md

Lines changed: 68 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,78 @@
11
# vanlug.ca
22

3-
Website for the Vancouver Linux Users Group
3+
Website for the Vancouver Linux Users Group.
4+
5+
[![Hugo CI](https://github.com/vanlug/vanlug.github.io/actions/workflows/hugo.yaml/badge.svg)](https://github.com/vanlug/vanlug.github.io/actions/workflows/hugo.yaml)
6+
![Go Version](https://img.shields.io/badge/go%20version-%3E=1.25-61CFDD.svg)
7+
[![Go Reference](https://pkg.go.dev/badge/github.com/vanlug/vanlug.github.io.svg)](https://pkg.go.dev/github.com/vanlug/vanlug.github.io)
48

59
## Overview
610

7-
🚧 This project is a work-in-progress! Instructions will be added as soon as it is usable. 🚧
11+
VanLUG is a non-profit user group for Linux professionals, hobbyists, and curious newcomers in the Greater Vancouver area, incorporated in 1999. The site is built with Hugo and PatternFly v6.
12+
13+
It provides the following:
14+
15+
- Home page with next meeting card (fetched from Luma API via a proxy hosted on Railway), "what to expect" cards, and social links
16+
- Events page with embedded Luma calendar iframe and full past event history
17+
- About page with mission, purpose mandates, and board of directors
18+
- Partners page listing library and community venue partners
19+
- Resources page with speaker slides, AGM documents, learning links, and design system
20+
- Membership page with benefits and registration link (Luma)
21+
- Code of Conduct, Terms of Service, and Privacy Policy pages
22+
- Donate card and land acknowledgment in the footer
23+
24+
The site is accessible at [https://vanlug.ca/](https://vanlug.ca/).
25+
26+
## Screenshots
27+
28+
Click on an image to see a larger version.
29+
30+
<a display="inline" href="./docs/home.png?raw=true">
31+
<img src="./docs/home.png" width="45%" alt="Screenshot of the home page" title="Screenshot of the home page">
32+
</a>
33+
34+
<a display="inline" href="./docs/events.png?raw=true">
35+
<img src="./docs/events.png" width="45%" alt="Screenshot of the events page" title="Screenshot of the events page">
36+
</a>
37+
38+
<a display="inline" href="./docs/about.png?raw=true">
39+
<img src="./docs/about.png" width="45%" alt="Screenshot of the about page" title="Screenshot of the about page">
40+
</a>
41+
42+
<a display="inline" href="./docs/resources.png?raw=true">
43+
<img src="./docs/resources.png" width="45%" alt="Screenshot of the resources page" title="Screenshot of the resources page">
44+
</a>
45+
46+
<a display="inline" href="./docs/partners.png?raw=true">
47+
<img src="./docs/partners.png" width="45%" alt="Screenshot of the partners page" title="Screenshot of the partners page">
48+
</a>
49+
50+
<a display="inline" href="./docs/membership.png?raw=true">
51+
<img src="./docs/membership.png" width="45%" alt="Screenshot of the membership page" title="Screenshot of the membership page">
52+
</a>
53+
54+
## Acknowledgements
55+
56+
- [gohugoio/hugo](https://github.com/gohugoio/hugo) provides the static site generator.
57+
- The open source [PatternFly design system](https://www.patternfly.org/) provides the UI components.
58+
- [FortAwesome/Font-Awesome](https://github.com/FortAwesome/Font-Awesome) provides the icons.
59+
- [lu.ma](https://lu.ma/) provides the event calendar and API.
60+
61+
## Contributing
62+
63+
To contribute, please use the [GitHub flow](https://guides.github.com/introduction/flow/) and follow our [Code of Conduct](./CODE_OF_CONDUCT.md).
64+
65+
To build the site locally, run:
66+
67+
```shell
68+
$ git clone https://github.com/vanlug/vanlug.github.io.git
69+
$ cd vanlug.github.io
70+
$ npm install
71+
$ hugo server
72+
```
873

974
## License
1075

11-
vanlug.ca (c) 2026 Felicitas Pojtinger
76+
vanlug.ca (c) 2026 Felicitas Pojtinger and contributors
1277

1378
SPDX-License-Identifier: AGPL-3.0

docs/about.png

1.35 MB
Loading

docs/events.png

600 KB
Loading

docs/home.png

539 KB
Loading

docs/membership.png

616 KB
Loading

docs/partners.png

696 KB
Loading

docs/resources.png

516 KB
Loading

0 commit comments

Comments
 (0)