Skip to content

Commit f0ca1d6

Browse files
committed
feat: Add logo and favicon to MkDocs documentation and adjust deployment workflow to include assets and fix paths.
1 parent 056ceb0 commit f0ca1d6

File tree

2 files changed

+13
-5
lines changed

2 files changed

+13
-5
lines changed

.github/workflows/deploy-docs.yml

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,21 @@ jobs:
2828

2929
- name: Prepare docs for MkDocs
3030
run: |
31-
# Sync root-level docs into docs/ to ensure latest content
31+
# Copy README as index page
3232
cp README.md docs/index.md
33-
cp CHANGELOG.md docs/changelog.md
3433
35-
# Fix doc links in index.md: docs/X → X
36-
# This converts links like (docs/ai-enhancement.md) to (ai-enhancement.md)
37-
# which is required when index.md is moved inside docs/
34+
# Copy logo into docs assets
35+
mkdir -p docs/assets
36+
cp apcore-toolkit-logo.svg docs/assets/
37+
38+
# Fix links in index.md: docs/X → X (since we're now inside docs/)
39+
sed -i 's|\./docs/|./|g' docs/index.md
3840
sed -i 's|(docs/|(|g' docs/index.md
3941
42+
# Fix logo reference in index.md
43+
sed -i 's|\./apcore-toolkit-logo\.svg|./assets/apcore-toolkit-logo.svg|g' docs/index.md
44+
45+
4046
- run: mkdocs build
4147

4248
- uses: actions/upload-pages-artifact@v3

mkdocs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ repo_name: aipartnerup/apcore-toolkit
55

66
theme:
77
name: material
8+
logo: assets/apcore-toolkit-logo.svg
9+
favicon: assets/apcore-toolkit-logo.svg
810
palette:
911
- scheme: default
1012
primary: deep purple

0 commit comments

Comments
 (0)