Skip to content

Commit 6b71e90

Browse files
committed
Add GitHub Pages workflow and README instructions
1 parent 5be4c03 commit 6b71e90

2 files changed

Lines changed: 52 additions & 0 deletions

File tree

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

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Build and deploy Jekyll site to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
- master
8+
9+
jobs:
10+
build-and-deploy:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Checkout repository
14+
uses: actions/checkout@v4
15+
16+
- name: Set up Ruby
17+
uses: ruby/setup-ruby@v1
18+
with:
19+
ruby-version: '3.1'
20+
21+
- name: Install Bundler and dependencies
22+
run: |
23+
gem install bundler
24+
bundle config set --local path vendor/bundle
25+
bundle install --jobs 4 --retry 3
26+
27+
- name: Build site with Jekyll
28+
run: bundle exec jekyll build --destination _site
29+
30+
- name: Deploy to GitHub Pages
31+
uses: peaceiris/actions-gh-pages@v4
32+
with:
33+
github_token: ${{ secrets.GITHUB_TOKEN }}
34+
publish_dir: ./_site

‎README.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,20 @@
11
# ParallelProgammingLabs
22
FPGA SoC Verilog HLS
3+
4+
## Publishing the site (GitHub Pages)
5+
6+
This repository uses Jekyll with the `just-the-docs` theme. A GitHub Actions workflow is included to build the site and publish it to the `gh-pages` branch automatically when `main` or `master` is pushed.
7+
8+
- To preview locally:
9+
10+
```bash
11+
gem install bundler
12+
bundle install
13+
bundle exec jekyll serve
14+
```
15+
16+
- The workflow file is at `.github/workflows/gh-pages.yml` and will build the site and publish the generated `_site` directory to the `gh-pages` branch using the built-in `GITHUB_TOKEN`.
17+
18+
- After pushing, enable GitHub Pages in the repository settings (if needed) to serve the `gh-pages` branch.
19+
20+
If you'd like, I can also create a `CNAME` file or configure a custom domain for Pages.

0 commit comments

Comments
 (0)