Skip to content

Commit 9bc44f2

Browse files
committed
Fix GitHub Pages build: proper theme config and workflow
- Switch from remote_theme to theme: just-the-docs (gem-based) - Add jekyll and jekyll-include-cache to Gemfile - Fix workflow step ID for configure-pages - Remove bundler-cache (no lock file), use bundle install - Remove conflicting collections config - Add Jekyll build artifacts to .gitignore
1 parent 4e63ef0 commit 9bc44f2

4 files changed

Lines changed: 21 additions & 40 deletions

File tree

.github/workflows/pages.yml

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,17 +20,24 @@ jobs:
2020
steps:
2121
- name: Checkout
2222
uses: actions/checkout@v4
23+
2324
- name: Setup Pages
25+
id: pages
2426
uses: actions/configure-pages@v5
27+
2528
- name: Setup Ruby
2629
uses: ruby/setup-ruby@v1
2730
with:
2831
ruby-version: '3.3'
29-
bundler-cache: true
32+
33+
- name: Install dependencies
34+
run: bundle install
35+
3036
- name: Build with Jekyll
3137
run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
3238
env:
3339
JEKYLL_ENV: production
40+
3441
- name: Upload artifact
3542
uses: actions/upload-pages-artifact@v3
3643

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@ Thumbs.db
1212
# Build artifacts
1313
node_modules/
1414
__pycache__/
15+
_site/
16+
.jekyll-cache/
17+
.jekyll-metadata
18+
vendor/
1519

1620
# Sensitive
1721
*.ovpn

Gemfile

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
source "https://rubygems.org"
22

3-
gem "jekyll-remote-theme"
4-
gem "just-the-docs"
3+
gem "jekyll", "~> 4.3"
4+
gem "just-the-docs", "0.10.0"
5+
gem "jekyll-include-cache"

_config.yml

Lines changed: 6 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ description: "The most comprehensive Hack The Box writeup collection - 500+ mach
33
url: "https://momenbasel.github.io"
44
baseurl: "/htb-writeups"
55

6-
remote_theme: just-the-docs/just-the-docs@v0.10.0
6+
theme: just-the-docs
77

88
color_scheme: dark
99

@@ -20,6 +20,9 @@ search.button: true
2020

2121
heading_anchors: true
2222

23+
plugins:
24+
- jekyll-include-cache
25+
2326
aux_links:
2427
"GitHub":
2528
- "https://github.com/momenbasel/htb-writeups"
@@ -33,17 +36,6 @@ back_to_top_text: "Back to top"
3336

3437
footer_content: 'Copyright &copy; 2026 <a href="https://github.com/momenbasel">Moamen Basel</a>. Distributed under the <a href="https://github.com/momenbasel/htb-writeups/blob/main/LICENSE">MIT License</a>.'
3538

36-
ga_tracking:
37-
ga_tracking_anonymize_ip: true
38-
39-
compress_html:
40-
clippings: all
41-
comments: all
42-
endings: all
43-
startings: []
44-
blanklines: false
45-
profile: false
46-
4739
callouts:
4840
warning:
4941
title: Warning
@@ -58,41 +50,18 @@ callouts:
5850
# Exclude files from the site
5951
exclude:
6052
- "0xdf-htb-machines.json"
53+
- "0xdf-htb-machines.md"
6154
- "ippsec-video-index.json"
55+
- "ippsec-video-index.md"
6256
- ".markdownlint.json"
6357
- "CONTRIBUTING.md"
6458
- "templates/"
6559
- "node_modules/"
6660
- "Gemfile"
6761
- "Gemfile.lock"
6862

69-
# Include dotfiles
70-
include:
71-
- ".github"
72-
73-
# Collections for better organization
74-
collections:
75-
machines:
76-
output: true
77-
permalink: /machines/:path/
78-
7963
defaults:
8064
- scope:
8165
path: ""
8266
values:
8367
layout: default
84-
- scope:
85-
path: "machines"
86-
values:
87-
layout: default
88-
parent: Machines
89-
- scope:
90-
path: "challenges"
91-
values:
92-
layout: default
93-
parent: Challenges
94-
- scope:
95-
path: "resources"
96-
values:
97-
layout: default
98-
parent: Resources

0 commit comments

Comments
 (0)