Skip to content

Commit 7154457

Browse files
feat: update local preview and better style for static sites
1 parent 5e4fac4 commit 7154457

13 files changed

Lines changed: 645 additions & 87 deletions

File tree

.github/workflows/deploy.yml

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,14 +30,11 @@ jobs:
3030
uses: actions/setup-python@v5
3131
with:
3232
python-version: "3.11"
33-
# cache: 'pip' # 缓存依赖,加速构建
34-
33+
cache: 'pip' # 缓存依赖,加速构建
34+
3535
# 3. 安装依赖
3636
- name: 安装依赖
37-
run: |
38-
pip install mkdocs-material
39-
pip install mkdocs-awesome-pages-plugin
40-
pip install mkdocs-git-revision-date-localized-plugin
37+
run: pip install -e ./scripts
4138

4239
# 4. 构建网站
4340
- name: 构建网站

.gitignore

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,19 @@ Makefile
2020
*.so
2121
*.exe
2222
*.out
23+
24+
# MkDocs build output
25+
site/
26+
27+
# Python virtual environment
28+
.venv/
29+
30+
# Python cache
31+
__pycache__/
32+
*.pyc
33+
34+
# MkDocs cache
35+
.cache/
36+
37+
# pip editable install artifacts
38+
*.egg-info/

mkdocs.yml

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,8 @@ theme:
4242

4343
# 字体配置
4444
font:
45-
text: Roboto # 正文字体
46-
code: Roboto Mono # 代码字体
45+
text: Noto Sans SC # 中文优先正文字体
46+
code: JetBrains Mono # 等宽字体,C++符号更清晰
4747

4848
# 功能特性开关
4949
features:
@@ -52,16 +52,17 @@ theme:
5252
- navigation.instant.prefetch # 预加载链接,提升访问速度
5353
- navigation.instant.progress # 显示加载进度条
5454
- navigation.tracking # 地址栏自动更新为当前标题的锚点
55+
- navigation.tabs # 顶部显示主要章节标签
56+
- navigation.tabs.sticky # 滚动时标签栏保持固定
5557
- navigation.sections # 侧边栏显示章节分组
56-
- navigation.expand # 默认展开所有章节(方便查看全部内容)
58+
- navigation.prune # 裁剪不可见的导航项,提升大站点性能
5759
- navigation.path # 显示当前页面的完整路径
5860
- navigation.indexes # 支持章节索引页
5961
- navigation.top # 显示"返回顶部"按钮
6062
- navigation.footer # 页面底部显示上一页/下一页导航
61-
63+
6264
# ---------- 目录功能 ----------
6365
- toc.follow # 目录自动跟随滚动
64-
- toc.integrate # 将右侧目录集成到左侧导航栏(节省空间)
6566

6667
# ---------- 搜索功能 ----------
6768
- search.suggest # 搜索时显示建议
@@ -196,11 +197,8 @@ extra:
196197
# ==================== 额外的CSS和JavaScript ====================
197198
# 可以添加自定义样式和脚本
198199

199-
extra_javascript:
200-
# 数学公式支持(MathJax)
201-
- javascripts/mathjax.js
202-
- https://polyfill.io/v3/polyfill.min.js?features=es6
203-
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
200+
extra_css:
201+
- stylesheets/extra.css
204202

205203

206204
# ==================== 注意事项 ====================

scripts/local_preview.sh

Lines changed: 0 additions & 20 deletions
This file was deleted.

scripts/mkdoc_setup_local_dependency.sh

Lines changed: 0 additions & 51 deletions
This file was deleted.

0 commit comments

Comments
 (0)