闰月主题 The Leap Month theme

releases license

Leap month 或「闰月」主题,是一款为 GitHub Jekyll(GitHub Pages 所驱动的 Jekyll)定制的网页主题,fork 自 GitHub Pages 官方推出的 Leap day 或「闰日」主题。

由于本主题为 GitHub Jekyll 定制,因此依赖于其所额外引入的若干插件;在原生 Jekyll 下使用本主题时,可能出现若干问题。

相较于原来的闰日主题,闰月对页面样式、配色、框架等都做了较大的改动,改进了若干已知问题,对中文内容支持更佳。

本主题目前由钱院学辅技术小组维护。事实上,本主题正好来自于钱院学辅使用 Leap day 主题过程中对其的优化与改进。

特性

  • 为中文页面量身定制,更符合国内人士的建站需求;
  • 充分优化了页面布局、正文排版,改善了移动端展示效果;
  • 采用对比更鲜明的配色方案,视觉效果好;
  • 页面内容精简,充分给予使用者自定义的空间;
  • 默认引入 Font Awesome、pangu.js、MathJax 等基本插件,并使用国内 CDN(BootCDN)加载插件,提升效果的同时不影响页面加载速度;

本主题衍生自钱院学辅信息站所采用的若干主题文件,因此更适合搭建「自由风」站点(不限于用 _posts 文件夹发布文章,而是在各级自定义目录下创建页面)——如项目主页、社团网站等,对一般的「博客风」站点也有较好支持。

使用

布置主题

如果您是从头开始新建一个用于 GitHub Pages 的代码仓库,请您:

  • 将该仓库 fork 到自己名下;
  • 将 fork 来的仓库克隆到本地,将仓库更名为自己所需的名称;
  • 将新的仓库上传至 GitHub;
  • 修改 _config.yml 配置文件,使之符合自己的需求;
  • 撰写首页 index.md、关于页面 about.md、日志页面 log.md(该页面可在 _config.yml 中关闭);
  • 基本工作完成,即可在 _posts 文件夹下以「博客风」新建文章,或在其他任何地方以「自由风」新建任意页面。

如果您已经有一个使用其他 Jekyll 主题的代码仓库,您需要:

  • _config.yml 或其他位置移除与旧主题相关的配置信息、样式文件;
  • 克隆本仓库,并将本仓库中的:
    • _config.yml 配置文件
    • _sass 目录(Sass 样式表)
    • index.mdabout.mdlog.md 文件(必要的基本页面,您可以自己创建或覆盖同名文件)
    • assets 目录(JavaScript 代码、图片元素、webfonts)

复制/覆盖到自己的仓库中——注意保留好自己的信息;

  • 提交改动,push 到 GitHub 上即可。

配置选项

本主题提供了五个选项接口,均已在本仓库的 _config.yml 展示:

  • title:网站标题,默认值为 GitHub 上的项目标题;
  • subtitle:网站副标题,默认值为 GitHub 上的项目描述;
  • author:网站作者/维护者,默认值为 GitHub 上的项目所有者(用户/组织);
  • log_button 选项:是否在导航栏打开「维护日志」选项;
  • cdnjs 选项:是否采用 cdnjs 提供的 CDN 服务加载插件,不声明或声明为 false 将使得网站用国内的 BootCDN 加载。

自定义

修改主题所定义的样式表,是最为普遍的需求。建议您在修改样式时,通过在 assets/css 目录下的 style.scss 增加条目来实现(覆盖),而尽量不要在 _sass 下已确定的主题文件中直接修改对应样式。

如您需要移除本主题默认支持的插件(不推荐),请您到 _includes/head.html 布局模块中移除代码引用,并同时在 assets/js/main.js 中移除对应的脚本实现。