Skip to content

Commit def1d75

Browse files
Merge pull request #1 from protontypes/web-setup
landing page scaffolding
2 parents efe48a7 + 908dec1 commit def1d75

18 files changed

Lines changed: 654 additions & 0 deletions

File tree

‎.github/workflows/hugo.yml‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
name: Deploy Hugo site to Pages
2+
3+
on:
4+
push:
5+
branches: ["main"]
6+
7+
workflow_dispatch:
8+
9+
permissions:
10+
contents: read
11+
pages: write
12+
id-token: write
13+
14+
concurrency:
15+
group: "pages"
16+
cancel-in-progress: false
17+
18+
defaults:
19+
run:
20+
shell: bash
21+
22+
jobs:
23+
# Build job
24+
build:
25+
runs-on: ubuntu-latest
26+
env:
27+
HUGO_VERSION: 0.124.1
28+
steps:
29+
- name: Install Hugo CLI
30+
run: |
31+
wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb \
32+
&& sudo dpkg -i ${{ runner.temp }}/hugo.deb
33+
- name: Checkout
34+
uses: actions/checkout@v4
35+
with:
36+
submodules: recursive
37+
fetch-depth: 0
38+
- name: Setup Pages
39+
id: pages
40+
uses: actions/configure-pages@v4
41+
- name: Build with Hugo
42+
env:
43+
# For maximum backward compatibility with Hugo modules
44+
HUGO_ENVIRONMENT: production
45+
HUGO_ENV: production
46+
run: |
47+
cd web
48+
hugo \
49+
--gc \
50+
--minify \
51+
--baseURL "${{ steps.pages.outputs.base_url }}/"
52+
- name: Upload artifact
53+
uses: actions/upload-pages-artifact@v3
54+
with:
55+
path: ./web/public
56+
57+
# Deployment job
58+
deploy:
59+
environment:
60+
name: github-pages
61+
url: ${{ steps.deployment.outputs.page_url }}
62+
runs-on: ubuntu-latest
63+
needs: build
64+
steps:
65+
- name: Deploy to GitHub Pages
66+
id: deployment
67+
uses: actions/deploy-pages@v4

‎.gitignore‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Icon?
1414
.Trashes
1515
config.plist
1616
*.swp
17+
ctx/
1718

1819
# Logs and databases
1920
*.log
@@ -23,3 +24,7 @@ config.plist
2324
.env
2425
.env.local
2526
.env.*.local
27+
28+
# Hugo
29+
web/public/
30+
web/resources/

‎README.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,42 @@ A framework that enables consistent assessment across environmental claims by br
1010
- `branding/`: Branding assets and [Figma Links](docs/website/branding/README.md)
1111
- `content/`: Landing page and audience-specific copy
1212
- `web/`: Source code for the static website
13+
- `content/`: Page content (Markdown)
14+
- `data/`: Structured data (YAML) used throughout the site
1315
- `assets/`: Shared images, icons, and infographics
1416

17+
## Running the Website
18+
19+
The website is built using [Hugo](https://gohugo.io/).
20+
21+
### Prerequisites
22+
23+
- [Hugo](https://gohugo.io/installation/) (extended version recommended)
24+
25+
### Local Development
26+
27+
1. Navigate to the `web` directory:
28+
```bash
29+
cd web
30+
```
31+
2. Start the Hugo development server:
32+
```bash
33+
hugo server -D
34+
```
35+
3. Open your browser to `http://localhost:1313`.
36+
37+
### Building for Production
38+
39+
To generate the static site files in the `web/public` directory:
40+
```bash
41+
cd web
42+
hugo
43+
```
44+
1545
## Contributing
1646

1747
Please place your documentation and drafts in the appropriate `docs/` subfolder. For website-related design, use the `docs/website/branding` folder to link Figma assets.
48+
49+
To contribute directly to the website content:
50+
- Update page text in `web/content/`.
51+
- Update structured data in `web/data/`.

‎web/.hugo_build.lock‎

Whitespace-only changes.

‎web/archetypes/default.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
+++
2+
date = '{{ .Date }}'
3+
draft = true
4+
title = '{{ replace .File.ContentBaseName "-" " " | title }}'
5+
+++

0 commit comments

Comments
 (0)