|  | 
|  | 1 | +# Auto Exploits - GitHub Pages | 
|  | 2 | + | 
|  | 3 | +This directory contains the GitHub Pages website for the Auto Exploits repository. | 
|  | 4 | + | 
|  | 5 | +## Structure | 
|  | 6 | + | 
|  | 7 | +- `index.html` - Main landing page with exploits table | 
|  | 8 | +- `_config.yml` - Jekyll configuration for GitHub Pages | 
|  | 9 | +- `Gemfile` - Ruby dependencies for local development | 
|  | 10 | +- `README.md` - This file | 
|  | 11 | + | 
|  | 12 | +## Features | 
|  | 13 | + | 
|  | 14 | +The landing page includes: | 
|  | 15 | +- Repository title and branding | 
|  | 16 | +- Link to security research articles | 
|  | 17 | +- Table of exploits with: | 
|  | 18 | +  - GHSA ID (linked to GitHub Security Advisories) | 
|  | 19 | +  - Link to exploit in repository (`exploits/{GHSA-ID}`) | 
|  | 20 | +  - Execution timestamp | 
|  | 21 | + | 
|  | 22 | +## Local Development | 
|  | 23 | + | 
|  | 24 | +### Option 1: Using Python Scripts (Recommended) | 
|  | 25 | + | 
|  | 26 | +**With Bundler (requires Ruby):** | 
|  | 27 | +```bash | 
|  | 28 | +python3 scripts/dev_server.py | 
|  | 29 | +``` | 
|  | 30 | + | 
|  | 31 | +**With Docker (no Ruby required):** | 
|  | 32 | +```bash | 
|  | 33 | +python3 scripts/dev_server_docker.py | 
|  | 34 | +``` | 
|  | 35 | + | 
|  | 36 | +Both will start a local server at **http://localhost:4000** | 
|  | 37 | + | 
|  | 38 | +### Option 2: Manual Setup | 
|  | 39 | + | 
|  | 40 | +1. Install Ruby and Bundler | 
|  | 41 | +2. Run `bundle install` in the `docs/` directory | 
|  | 42 | +3. Run `bundle exec jekyll serve --livereload` | 
|  | 43 | + | 
|  | 44 | +### Option 3: Simple HTTP Server | 
|  | 45 | + | 
|  | 46 | +For basic testing without Jekyll features: | 
|  | 47 | +```bash | 
|  | 48 | +cd docs | 
|  | 49 | +python3 -m http.server 8000 | 
|  | 50 | +``` | 
|  | 51 | +Then visit **http://localhost:8000** | 
|  | 52 | + | 
|  | 53 | +## Setup | 
|  | 54 | + | 
|  | 55 | +1. Enable GitHub Pages in your repository settings | 
|  | 56 | +2. Set source to "Deploy from a branch" | 
|  | 57 | +3. Select the `main` branch and `/docs` folder | 
|  | 58 | +4. Update `_config.yml` with your actual GitHub username and repository name | 
|  | 59 | +5. Update the exploits data in `index.html` with real exploit information | 
|  | 60 | + | 
|  | 61 | +## Customization | 
|  | 62 | + | 
|  | 63 | +- Update the `exploits` array in `index.html` with real exploit data | 
|  | 64 | +- Modify the article link to point to your actual blog/research | 
|  | 65 | +- Customize the styling in the CSS section | 
|  | 66 | +- Add more features as needed | 
|  | 67 | + | 
|  | 68 | +## Deployment | 
|  | 69 | + | 
|  | 70 | +GitHub Pages will automatically build and deploy your site when you push changes to the main branch. | 
0 commit comments