Skip to content

Commit 050e4d8

Browse files
jedisct1jedisct1
committed
Update configuration for renamed repository ipcrypt-std.github.io
1 parent 25eaa4c commit 050e4d8

File tree

3 files changed

+88
-31
lines changed

3 files changed

+88
-31
lines changed

‎.github/workflows/jekyll-gh-pages.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Deploy to GitHub Pages
1+
name: Deploy to GitHub Pages (ipcrypt-std.github.io)
22

33
on:
44
push:

‎configure-gh-pages.sh‎

Lines changed: 18 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,13 @@ NC='\033[0m' # No Color
1111
echo -e "${YELLOW}GitHub Pages Configuration Helper${NC}"
1212
echo -e "${YELLOW}=================================${NC}\n"
1313

14-
echo -e "${YELLOW}This script will help you configure GitHub Pages to deploy your site to the root URL.${NC}"
15-
echo -e "${YELLOW}Please follow these steps:${NC}\n"
14+
echo -e "${GREEN}Great news! Your repository is now named 'ipcrypt-std.github.io'.${NC}"
15+
echo -e "${GREEN}This is the optimal configuration for GitHub Pages.${NC}\n"
16+
17+
echo -e "${YELLOW}Please follow these steps to ensure everything is configured correctly:${NC}\n"
1618

1719
echo -e "1. ${GREEN}Go to your GitHub repository:${NC}"
18-
echo -e " https://github.com/ipcrypt-std/www/settings/pages\n"
20+
echo -e " https://github.com/ipcrypt-std/ipcrypt-std.github.io/settings/pages\n"
1921

2022
echo -e "2. ${GREEN}Under 'Build and deployment' section:${NC}"
2123
echo -e " - Source: ${YELLOW}GitHub Actions${NC}"
@@ -24,32 +26,18 @@ echo -e " (This should already be selected)\n"
2426
echo -e "3. ${GREEN}Under 'Custom domain' section:${NC}"
2527
echo -e " - Make sure this is empty (unless you want to use a custom domain)\n"
2628

27-
echo -e "4. ${GREEN}Check your repository name:${NC}"
28-
echo -e " - If your repository is named 'ipcrypt-std.github.io', your site will be published at:"
29-
echo -e " ${YELLOW}https://ipcrypt-std.github.io/${NC}"
30-
echo -e " - If your repository is named 'www', your site will be published at:"
31-
echo -e " ${YELLOW}https://ipcrypt-std.github.io/www/${NC}"
32-
echo -e " - To publish at the root URL with a repository named 'www', you need to:"
33-
echo -e " a. Create a new repository named 'ipcrypt-std.github.io'"
34-
echo -e " b. Push your code to that repository"
35-
echo -e " c. Configure GitHub Pages as described above\n"
36-
37-
echo -e "5. ${GREEN}Alternative approach - Create a gh-pages branch:${NC}"
38-
echo -e " If you want to keep your repository name as 'www' but deploy to the root URL,"
39-
echo -e " you can create a gh-pages branch with a special structure:"
40-
echo -e " $()$(bash"
41-
echo -e " git checkout --orphan gh-pages"
42-
echo -e " git rm -rf ."
43-
echo -e " echo '<meta http-equiv=\"refresh\" content=\"0;url=https://ipcrypt-std.github.io/www/\">' \
44-
git add index.html"
45-
echo -e " git commit -m \"Add redirect to www subdirectory\""
46-
echo -e " git push origin gh-pages"
47-
echo -e " >index.html"
48-
echo -e ")$()"
49-
echo -e " Then in GitHub repository settings, set the source to 'Deploy from a branch'"
50-
echo -e " and select the 'gh-pages' branch.\n"
51-
52-
echo -e "${YELLOW}After making these changes, your site should be deployed to the root URL.${NC}"
53-
echo -e "${YELLOW}It may take a few minutes for the changes to take effect.${NC}\n"
29+
echo -e "4. ${GREEN}Verify your site is being published:${NC}"
30+
echo -e " - Your site should be published at: ${YELLOW}https://ipcrypt-std.github.io/${NC}"
31+
echo -e " - It may take a few minutes for the changes to take effect\n"
32+
33+
echo -e "5. ${GREEN}If you encounter any issues:${NC}"
34+
echo -e " - Check the 'Actions' tab in your GitHub repository to see if the workflow is running successfully"
35+
echo -e " - Make sure your _config.yml has the correct URL and baseurl settings:"
36+
echo -e " baseurl: \"\" # empty for root URL"
37+
echo -e " url: \"https://ipcrypt-std.github.io\" # the base hostname & protocol for your site"
38+
echo -e "\n"
39+
40+
echo -e "${YELLOW}With the repository named 'ipcrypt-std.github.io', GitHub Pages will automatically${NC}"
41+
echo -e "${YELLOW}deploy your site to the root URL. No additional configuration is needed.${NC}\n"
5442

5543
echo -e "${GREEN}Done!${NC}"

‎github-pages-setup.md‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# GitHub Pages Setup Guide
2+
3+
This guide will help you configure your GitHub Pages deployment to serve your website from the root URL `https://ipcrypt-std.github.io/`.
4+
5+
## Current Configuration
6+
7+
Your Jekyll site is located in the `www` directory, and your repository is now named `ipcrypt-std.github.io`, which means GitHub Pages will automatically deploy to the root URL.
8+
9+
## Step 1: Repository Settings
10+
11+
1. Go to your GitHub repository (`https://github.com/ipcrypt-std/www`)
12+
2. Click on "Settings" tab
13+
3. In the left sidebar, click on "Pages"
14+
4. Under "Build and deployment" section:
15+
- For "Source", select "GitHub Actions"
16+
- This will use your workflow file to build and deploy the site
17+
18+
## Step 2: Custom Domain (Optional)
19+
20+
If you want to use your custom domain `ipcrypt.stdc.org`:
21+
22+
1. In the GitHub Pages settings, under "Custom domain":
23+
- Enter your domain: `ipcrypt.stdc.org`
24+
- Check "Enforce HTTPS" if it's not already enabled
25+
2. Make sure your DNS provider has the correct records:
26+
- An `A` record pointing to GitHub Pages IP addresses:
27+
```
28+
185.199.108.153
29+
185.199.109.153
30+
185.199.110.153
31+
185.199.111.153
32+
```
33+
- Or a `CNAME` record pointing to `ipcrypt-std.github.io`
34+
35+
## Step 3: Alternative Approach - Using gh-pages Branch
36+
37+
If the above configuration doesn't work, you can try using a dedicated `gh-pages` branch:
38+
39+
1. Create a new orphan branch named `gh-pages`:
40+
```bash
41+
git checkout --orphan gh-pages
42+
git rm -rf .
43+
```
44+
45+
2. Create a simple index.html file to redirect to the correct location:
46+
```bash
47+
echo '<meta http-equiv="refresh" content="0;url=https://ipcrypt-std.github.io/www/">' > index.html
48+
```
49+
50+
3. Commit and push the changes:
51+
```bash
52+
git add index.html
53+
git commit -m "Add redirect to www subdirectory"
54+
git push origin gh-pages
55+
```
56+
57+
4. In GitHub repository settings, under "Pages":
58+
- Set the source to "Deploy from a branch"
59+
- Select the "gh-pages" branch and "/ (root)" folder
60+
- Click "Save"
61+
62+
## Troubleshooting
63+
64+
If you continue to experience issues:
65+
66+
1. Check the GitHub Actions workflow logs for any errors
67+
2. Verify that the `_site` directory is being correctly generated in the `www` directory
68+
3. Make sure the `baseurl` in `_config.yml` is set correctly (empty for root URL)
69+
4. Ensure your custom domain configuration is correct if you're using one

0 commit comments

Comments
 (0)