Skip to content

Commit 6caf4c6

Browse files
committed
fix: correct GitHub Pages deployment for MkDocs
- Fix workflow to properly handle MkDocs deployment - Add .nojekyll file to disable Jekyll processing - Update repository URLs in mkdocs.yml - Add git configuration for automated deployment
1 parent 03ff254 commit 6caf4c6

File tree

3 files changed

+11
-7
lines changed

3 files changed

+11
-7
lines changed

.github/workflows/deploy-docs.yml

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: build-mkdocs-gh-pages-branch
1+
name: Deploy MkDocs to GitHub Pages
22

33
on:
44
push:
@@ -17,15 +17,19 @@ jobs:
1717
with:
1818
fetch-depth: 0
1919

20-
- uses: actions/setup-python@v5
20+
- name: Setup Python
21+
uses: actions/setup-python@v5
2122
with:
2223
python-version: '3.x'
2324

2425
- name: Install dependencies
2526
run: |
2627
pip install mkdocs-material mkdocs-git-revision-date-localized-plugin pymdown-extensions mkdocs-mermaid2-plugin
2728
28-
- name: Deploy to GitHub Pages
29-
run: mkdocs gh-deploy --force
29+
- name: Build and deploy to GitHub Pages
30+
run: |
31+
git config --global user.name "github-actions[bot]"
32+
git config --global user.email "github-actions[bot]@users.noreply.github.com"
33+
mkdocs gh-deploy --force --clean
3034
env:
3135
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.nojekyll

Whitespace-only changes.

mkdocs.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
site_name: Codebase Interface
22
site_description: A documented set of principles that aim to promote the ease of use of codebases across languages and frameworks
3-
site_url: https://codebaseinterface.org
4-
repo_url: https://github.com/codebase-interface/codebaseinterface
5-
repo_name: codebase-interface/codebaseinterface
3+
site_url: https://codebase-interface.github.io/docs/
4+
repo_url: https://github.com/codebase-interface/docs
5+
repo_name: codebase-interface/docs
66
edit_uri: edit/main/docs/
77

88
theme:

0 commit comments

Comments
 (0)