Skip to content

Commit fd9541e

Browse files
committed
feat: Add GitHub Actions workflow for automatic documentation deployment
1 parent 45e18ba commit fd9541e

3 files changed

Lines changed: 39 additions & 1 deletion

File tree

.github/copilot-instructions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
The project name is "firescript", all lowercase. Do not capitalize it.
1+
The project name is "firescript", all lowercase. Do not capitalize it. Make sure you are not removing random code.

.github/workflows/deploy-docs.yml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Deploy firescript Documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- main # Set this to your default branch
7+
paths:
8+
- 'docs/**'
9+
- 'mkdocs.yml'
10+
11+
permissions:
12+
contents: write
13+
14+
jobs:
15+
deploy:
16+
runs-on: ubuntu-latest
17+
steps:
18+
- uses: actions/checkout@v3
19+
with:
20+
fetch-depth: 0
21+
22+
- name: Set up Python
23+
uses: actions/setup-python@v4
24+
with:
25+
python-version: '3.10'
26+
27+
- name: Install dependencies
28+
run: |
29+
python -m pip install --upgrade pip
30+
pip install mkdocs-material
31+
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
32+
33+
- name: Deploy Documentation
34+
run: mkdocs gh-deploy --force --clean

mkdocs.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@ theme:
1212
- search.highlight
1313
- content.code.copy
1414
- content.action.edit
15+
# GitHub Pages deployment configuration
16+
deploy:
17+
provider: github
18+
branch: gh-pages
1519
nav:
1620
- Home: README.md
1721
- Language Specification: language_specification.md

0 commit comments

Comments
 (0)