这个仓库托管了 ltmc.top 的个人站点,使用 MkDocs + Material for MkDocs 构建,部署在 GitHub Pages。
需要 Python 3.x 与 Node.js(生成搜索索引用)。
pip install mkdocs-material thumbhash Pillow beautifulsoup4
mkdocs serve # 本地预览 http://localhost:8000(不含搜索索引)
mkdocs build # 构建静态文件到 site/搜索由 Pagefind 提供,索引在 mkdocs build 之后生成。
想本地完整体验搜索,可执行:
mkdocs build
npx --yes pagefind@^1.5.0 --site site --force-language zh --serve每次推送到 main 分支时,GitHub Actions 会自动:
- 安装 MkDocs Material
- 运行
mkdocs build - 运行
pagefind生成中文搜索索引到site/pagefind/ - 将根目录的 HTML/静态文件复制到构建输出
- 通过
peaceiris/actions-gh-pages部署到gh-pages分支
- Material 内置的
search插件已移除,改由 Pagefind 索引。 plugins/pagefind/hooks.py在页面中注入 Component UI 资源、data-pagefind-body正文标记与<pagefind-modal>弹窗。overrides/partials/header.html用<pagefind-modal-trigger>替换页头搜索入口 (默认快捷键Ctrl/⌘ + K,同时保留/)。docs/assets/css/pagefind-theme.css负责与 Material 亮/暗色主题对齐。
- QQ: 2827927233
- Bilibili: Java8ver64/106366650