Skip to content

Commit e42f675

Browse files
ninyaweeclaude
andcommitted
ci: add GitHub Actions workflow and custom MkDocs theme
🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 40fe418 commit e42f675

File tree

3 files changed

+59
-0
lines changed

3 files changed

+59
-0
lines changed

.github/workflows/docs.yml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: Deploy Docs
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
paths:
8+
- 'docs/**'
9+
- 'mkdocs.yml'
10+
- '.github/workflows/docs.yml'
11+
workflow_dispatch:
12+
13+
permissions:
14+
contents: write
15+
16+
jobs:
17+
deploy:
18+
runs-on: ubuntu-latest
19+
steps:
20+
- uses: actions/checkout@v4
21+
22+
- name: Setup Python
23+
uses: actions/setup-python@v5
24+
with:
25+
python-version: '3.12'
26+
27+
- name: Install dependencies
28+
run: |
29+
pip install mkdocs mkdocs-material
30+
31+
- name: Build and deploy
32+
run: |
33+
mkdocs gh-deploy --force

docs/overrides/main.html

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
{% extends "base.html" %}
2+
3+
{% block content %}
4+
{{ super() }}
5+
6+
<h2 id="__comments">{{ lang.t("meta.comments") }}</h2>
7+
8+
<script
9+
src="https://giscus.app/client.js"
10+
data-repo="ninyawee/konjingjing"
11+
data-repo-id="REPLACE_WITH_REPO_ID"
12+
data-category="General"
13+
data-category-id="REPLACE_WITH_CATEGORY_ID"
14+
data-mapping="pathname"
15+
data-strict="0"
16+
data-reactions-enabled="1"
17+
data-emit-metadata="0"
18+
data-input-position="bottom"
19+
data-theme="preferred_color_scheme"
20+
data-lang="en"
21+
data-loading="lazy"
22+
crossorigin="anonymous"
23+
async
24+
></script>
25+
{% endblock %}

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ repo_name: ninyawee/konjingjing
66

77
theme:
88
name: material
9+
custom_dir: docs/overrides
910
palette:
1011
- scheme: default
1112
primary: indigo

0 commit comments

Comments
 (0)