如何在 GitHub Pages 上配置 Jekyll 网站
访问目标仓库
打开需要启用 GitHub Pages 的仓库,并进入 Settings(设置)中的 Pages 页面。
设置发布来源
在 Build and deployment(构建与部署)部分的 Source 下,选择 GitHub Actions 作为发布来源。
确认后,系统会提示你需要创建一个名为 .github/workflows/jekyll-gh-pages.yml
的文件。直接提交(Commit)即可完成这一步。
创建配置文件 _config.yml
在仓库的根目录下,创建一个 _config.yml
文件。以下为使用 Just The Docs Jekyll 主题的示例配置,您也可以选择其他主题。在 Jekyll Themes 上可以找到更多主题。
remote_theme: just-the-docs/just-the-docs
plugins:
- jekyll-remote-theme
- jekyll-seo-tag
- jekyll-sitemap
- jekyll-readme-index
- jekyll-relative-links
color_scheme: dark
search_enabled: true
heading_anchors: true
aux_links: {}
nav_external_links: []
sass:
style: compressed
说明
remote_theme
: 指定远程主题,此处为 Just The Docs。
- 插件: 常用的 Jekyll 插件如
jekyll-seo-tag
可提升 SEO,jekyll-sitemap
可生成站点地图。
- 颜色方案: 设置为
dark
深色模式。
- 搜索功能: 启用站点搜索功能。
完成以上步骤后,您可以提交代码并访问 GitHub Pages 查看效果。如果需要更换主题或调整其他设置,可以随时修改 _config.yml
文件并重新推送代码。