-
-
Notifications
You must be signed in to change notification settings - Fork 3
55 lines (47 loc) · 1.86 KB
/
Deploy MkDocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
name: 📖 Deploy MkDocs to GitHub Pages
on:
push:
branches:
- main # The branch you want to deploy from
paths: # Only deploy MkDocs when the contents of the docs folder change or when this workflow changes.
- 'docs/**'
- '.github/workflows/Deploy MkDocs.yml'
- './mkdocs.yml'
workflow_dispatch:
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: ✅ Checkout Repository
uses: actions/checkout@v4
- name: 🐍 Setup Python
uses: actions/setup-python@v5
with:
python-version: '3.x' # specify the Python version
- name: ➕ Install Dependencies
run: |
python -m pip install --upgrade pip
pip install mkdocs mkdocs-material
- name: 👷♂️ Build & Deploy MkDocs
run: |
mkdocs build
mkdocs gh-deploy --force
# Combine markdown files to create the MkDocs index and the repository readme
- name: 📖 Update Index & Readme
shell: pwsh
run: |
$IndexTop = Get-Content -Path ./docs/index.md -TotalCount 46
$ModuleContent = Get-Content -Path ./docs/PSPreworkout.md | Select-Object -Skip 12
$FooterContent = "`n</Details>`n"
$CombinedContent = $IndexTop + $ModuleContent + $FooterContent
$CombinedContent | Set-Content -Path ./docs/index.md
$ModuleContent = $ModuleContent.Replace( '](' , '](./docs/' )
$CombinedContent = $IndexTop + $ModuleContent
$CombinedContent | Set-Content -Path ./README.md
# Copy-Item ./docs/index.md ./README.md
# git-auto-commit-action only runs on Linux-based platforms.
- name: 💾 Commit Changes
uses: stefanzweifel/git-auto-commit-action@v5
with:
commit_message: 'Copy MkDocs index to README'
file_pattern: 'docs/index.md README.md'