Skip to content

Commit 9e42fb5

Browse files
fix: add GitHub Actions Pages deployment and Jekyll config for proper rendering (#130)
GitHub Pages is running Jekyll and rendering README.md as the site instead of serving our OSINT toolkit index.html. This adds: 1. GitHub Actions workflow (pages.yml) that deploys docs/ as a static site using actions/deploy-pages, bypassing Jekyll entirely 2. _config.yml with theme:null to disable Jekyll themes 3. Jekyll front matter (layout:null) on index.html so Jekyll outputs our HTML without theme wrapping 4. Excludes README.md and non-website files from Jekyll build Covers both "Deploy from branch" and "GitHub Actions" deployment modes. https://claude.ai/code/session_01LJNJws3Tyq7jFNGVAYBszq Co-authored-by: Claude <noreply@anthropic.com>
1 parent 240b194 commit 9e42fb5

5 files changed

Lines changed: 84 additions & 0 deletions

File tree

.github/workflows/pages.yml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: Deploy to GitHub Pages
2+
3+
on:
4+
push:
5+
branches: ["main"]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
concurrency:
14+
group: "pages"
15+
cancel-in-progress: false
16+
17+
jobs:
18+
deploy:
19+
environment:
20+
name: github-pages
21+
url: ${{ steps.deployment.outputs.page_url }}
22+
runs-on: ubuntu-latest
23+
steps:
24+
- name: Checkout
25+
uses: actions/checkout@v4
26+
27+
- name: Setup Pages
28+
uses: actions/configure-pages@v5
29+
30+
- name: Upload artifact
31+
uses: actions/upload-pages-artifact@v3
32+
with:
33+
path: 'docs'
34+
35+
- name: Deploy to GitHub Pages
36+
id: deployment
37+
uses: actions/deploy-pages@v4

_config.yml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
title: Spin Web
2+
description: Privacy-first OSINT investigation toolkit
3+
theme: null
4+
plugins: []
5+
exclude:
6+
- README.md
7+
- CLAUDE.md
8+
- LICENSE
9+
- package.json
10+
- package-lock.json
11+
- node_modules
12+
- app
13+
- src
14+
- tests
15+
- scripts
16+
- assets
17+
- eslint.config.mjs
18+
- vite.config.mjs
19+
- svelte.config.mjs
20+
- .prettierrc
21+
- .prettierignore
22+
- fb-prefix-list-gen.md
23+
- install.sh
24+
include:
25+
- .nojekyll
26+
- index.html
27+
- style.css
28+
- app.js

docs/_config.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
title: Spin Web
2+
description: Privacy-first OSINT investigation toolkit
3+
theme: null
4+
plugins: []
5+
exclude:
6+
- README.md
7+
include:
8+
- .nojekyll
9+
- index.html
10+
- style.css
11+
- app.js

docs/index.html

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
layout: null
3+
permalink: /index.html
4+
---
15
<!DOCTYPE html>
26
<html lang="en">
37
<head>

index.html

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
layout: null
3+
permalink: /index.html
4+
---
15
<!DOCTYPE html>
26
<html lang="en">
37
<head>

0 commit comments

Comments
 (0)