Skip to content

Commit b5837f2

Browse files
committed
feat(doc): gh pages site
1 parent fd889a5 commit b5837f2

9 files changed

Lines changed: 2335 additions & 0 deletions

File tree

.github/workflows/deploy-pages.yml

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# GitHub Actions workflow to deploy the website to GitHub Pages
2+
3+
name: Deploy to GitHub Pages
4+
5+
on:
6+
# Runs on pushes targeting the default branch
7+
push:
8+
branches: ["master"]
9+
paths:
10+
- 'docs/**'
11+
- '.github/workflows/deploy-pages.yml'
12+
13+
# Allows you to run this workflow manually from the Actions tab
14+
workflow_dispatch:
15+
16+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
17+
permissions:
18+
contents: read
19+
pages: write
20+
id-token: write
21+
22+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
23+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
24+
concurrency:
25+
group: "pages"
26+
cancel-in-progress: false
27+
28+
jobs:
29+
# Build job
30+
build:
31+
runs-on: ubuntu-latest
32+
steps:
33+
- name: Checkout
34+
uses: actions/checkout@v4
35+
36+
- name: Setup Pages
37+
uses: actions/configure-pages@v4
38+
39+
- name: Upload artifact
40+
uses: actions/upload-pages-artifact@v3
41+
with:
42+
# Upload the docs folder
43+
path: './docs'
44+
45+
# Deployment job
46+
deploy:
47+
environment:
48+
name: github-pages
49+
url: ${{ steps.deployment.outputs.page_url }}
50+
runs-on: ubuntu-latest
51+
needs: build
52+
steps:
53+
- name: Deploy to GitHub Pages
54+
id: deployment
55+
uses: actions/deploy-pages@v4

.vscodeignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,5 @@ Makefile
1212
**/.DS_Store
1313
.rayhist.dat
1414
package-lock.json
15+
docs/**
16+
.github/**

docs/.nojekyll

Whitespace-only changes.

docs/images/demo.png

436 KB
Loading

docs/images/favicon.svg

Lines changed: 255 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)