Skip to content

Commit 893408f

Browse files
docs: streamline README and add Pages site
1 parent 19ebec1 commit 893408f

24 files changed

Lines changed: 1194 additions & 583 deletions

‎.github/workflows/docs.yml‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Deploy documentation
2+
3+
on:
4+
push:
5+
branches: [main]
6+
paths:
7+
- "docs/**"
8+
- ".github/workflows/docs.yml"
9+
workflow_dispatch:
10+
11+
permissions:
12+
contents: write
13+
14+
concurrency:
15+
group: documentation
16+
cancel-in-progress: true
17+
18+
jobs:
19+
deploy:
20+
runs-on: ubuntu-latest
21+
steps:
22+
- name: Check out repository
23+
uses: actions/checkout@v4
24+
with:
25+
fetch-depth: 0
26+
27+
- name: Install Hugo
28+
uses: peaceiris/actions-hugo@v3
29+
with:
30+
hugo-version: "0.151.0"
31+
extended: true
32+
33+
- name: Build site
34+
run: hugo --source docs --minify
35+
36+
- name: Publish gh-pages branch
37+
uses: peaceiris/actions-gh-pages@v4
38+
with:
39+
github_token: ${{ secrets.GITHUB_TOKEN }}
40+
publish_branch: gh-pages
41+
publish_dir: ./docs/public
42+
force_orphan: true

0 commit comments

Comments
 (0)