Skip to content

Commit 83f08a1

Browse files
committed
add: static website generation workflow
1 parent ba007f0 commit 83f08a1

2 files changed

Lines changed: 34 additions & 0 deletions

File tree

.github/workflows/deploy-docs.yml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Deploy Docs
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
jobs:
9+
deploy:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v4
13+
- name: Configure Git
14+
run: |
15+
git config user.name "GitHub Actions Bot"
16+
git config user.email "github-actions[bot]@users.noreply.github.com"
17+
- name: Set up Python
18+
uses: actions/setup-python@v5
19+
with:
20+
python-version: 3.x
21+
- name: Install dependencies
22+
run: |
23+
pip install mkdocs mkdocs-readthedocs-theme
24+
- name: Deploy docs
25+
run: mkdocs gh-deploy --force

mkdocs.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
site_name: TrainCheck
2+
theme:
3+
name: readthedocs
4+
nav:
5+
- Home: README.md
6+
- "Installation Guide": ./installation-guide.md
7+
- "5 Minute Quick Start": ./5-min-tutorial.md
8+
- "Technical Documentation": ./technical-doc.md
9+
- "Usage Tips": usage-guide.md

0 commit comments

Comments
 (0)