Skip to content

Commit 0241def

Browse files
committed
Rewrite site with Hugo
This rewrites the Helmet documentation site with [Hugo] instead of Jekyll. It also reorganizes a few things and updates the style. However, the main page content is nearly identical. I have much preferred the speed, simplicity, and reliability of Hugo over Jekyll, which motivates this switch. [Hugo]: https://gohugo.io/
1 parent ac22678 commit 0241def

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+629
-1035
lines changed

.github/workflows/hugo.yaml

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# Sample workflow for building and deploying a Hugo site to GitHub Pages
2+
name: Deploy Hugo site to Pages
3+
4+
on:
5+
# Runs on pushes targeting the default branch
6+
push:
7+
branches:
8+
- main
9+
10+
# Allows you to run this workflow manually from the Actions tab
11+
workflow_dispatch:
12+
13+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
14+
permissions:
15+
contents: read
16+
pages: write
17+
id-token: write
18+
19+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
20+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
21+
concurrency:
22+
group: "pages"
23+
cancel-in-progress: false
24+
25+
# Default to bash
26+
defaults:
27+
run:
28+
shell: bash
29+
30+
jobs:
31+
# Build job
32+
build:
33+
runs-on: ubuntu-latest
34+
env:
35+
HUGO_VERSION: 0.112.7
36+
steps:
37+
- name: Install Hugo CLI
38+
run: |
39+
wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb \
40+
&& sudo dpkg -i ${{ runner.temp }}/hugo.deb
41+
- name: Install Dart Sass Embedded
42+
run: sudo snap install dart-sass-embedded
43+
- name: Checkout
44+
uses: actions/checkout@v3
45+
with:
46+
submodules: recursive
47+
fetch-depth: 0
48+
- name: Setup Pages
49+
id: pages
50+
uses: actions/configure-pages@v3
51+
- name: Install Node.js dependencies
52+
run: "[[ -f package-lock.json || -f npm-shrinkwrap.json ]] && npm ci || true"
53+
- name: Build with Hugo
54+
env:
55+
# For maximum backward compatibility with Hugo modules
56+
HUGO_ENVIRONMENT: production
57+
HUGO_ENV: production
58+
run: |
59+
hugo \
60+
--gc \
61+
--minify \
62+
--baseURL "${{ steps.pages.outputs.base_url }}/"
63+
- name: Upload artifact
64+
uses: actions/upload-pages-artifact@v1
65+
with:
66+
path: ./public
67+
68+
# Deployment job
69+
deploy:
70+
environment:
71+
name: github-pages
72+
url: ${{ steps.deployment.outputs.page_url }}
73+
runs-on: ubuntu-latest
74+
needs: build
75+
steps:
76+
- name: Deploy to GitHub Pages
77+
id: deployment
78+
uses: actions/deploy-pages@v2

.gitignore

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,16 @@
1-
_site
2-
.sass-cache
3-
.jekyll-metadata
4-
/.jekyll-cache/
1+
# Generated files by hugo
2+
/public/
3+
/resources/_gen/
4+
/assets/jsconfig.json
5+
hugo_stats.json
6+
7+
# Executable may be added to repository
8+
hugo.exe
9+
hugo.darwin
10+
hugo.linux
11+
12+
# Temporary lock file while building
13+
/.hugo_build.lock
14+
15+
# npm
16+
/node_modules/

Gemfile

Lines changed: 0 additions & 12 deletions
This file was deleted.

Gemfile.lock

Lines changed: 0 additions & 265 deletions
This file was deleted.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
helmetjs.github.io
22
==================
33

4-
This is the [Jekyll](https://jekyllrb.com/)-powered site that powers Helmet's website.
4+
This is the documentation for Helmet, built with [Hugo](https://gohugo.io/).

_config.yml

Lines changed: 0 additions & 10 deletions
This file was deleted.

0 commit comments

Comments
 (0)