Skip to content

Latest commit

 

History

History
108 lines (72 loc) · 3.95 KB

readme.md

File metadata and controls

108 lines (72 loc) · 3.95 KB
Raw

下载安装

为满足多种使用场景，本主题提供了相应的方式——

包管理器

Jekyll 的主题暂不支持通过 Gem{:target="_blank"}{:rel="external "} 的方式使用，且 Ruby 版本最好为 2.3.0。

若 Hexo 的版本在 5.0.0{:target="_blank"}{:rel="external "} 及以上，可在项目根文件夹下通过 npm i hexo-theme-lime 安装使用。

压缩包

访问源码仓库的 GitHub Releases{:target="_blank"}{:rel="external "} 页面，在目标版本的「Assets」中下载与静态网站生成器相匹配的压缩包到本地：

  • jekyll-theme-lime.zip
  • hexo-theme-lime.zip

解压后将文件夹与文件复制或挪动到自己项目的指定位置。

运行网站

在将主题文件都弄到自己项目中后，为了让网站能够成功运行并看到效果，需了解以下事宜——

目录结构

为保持在不同静态网站生成器中使用体验一致性，主题预置的静态资源存放在：

[ASSET_ROOT]
   ├── fonts
   │   └── ...
   ├── images
   │   └── ...
   ├── javascripts
   │   └── ...
   └── stylesheets
       └── ...

[ASSET_ROOT] 在 Jekyll 和 Hexo 中分别是 _assets 与 themes/lime/source。即便如此，在实际使用时自定义文件的目录结构可以不按照这个来。

无论是静态资源还是动态模板，主题所提供的和强依赖的基本都放在 ksio 或 _ksio 文件夹下。

创建文件

有几个静态资源文件是要手动创建的——

全局依赖

创建 [ASSET_ROOT]/stylesheets/_helper.scss，内容为：

@import "ksio/helper";

创建 [ASSET_ROOT]/stylesheets/global.scss，内容为：

@import "ksio/all";

若是在 Jekyll 中使用，还要创建 [ASSET_ROOT]/javascripts/global.js，内容为：

//= require ./ksio/vendors/jquery-1.11.3.min
//= require ./ksio/bootstrap-sprockets.js

页面依赖

当要使用主题预置页面的样式时，需要为每个页面创建单独的样式文件并通过 @import 去导入：

页面 布局模板 预置样式文件
文章列表 ksio/page 或 page [ASSET_ROOT]/stylesheets/ksio/pages/_posts.scss
文章详情 ksio/post 或 post [ASSET_ROOT]/stylesheets/ksio/pages/_post.scss
文档详情 ksio/doc [ASSET_ROOT]/stylesheets/ksio/pages/_doc.scss

主题配置

在 Hexo 中，可通过指定方式{:target="_blank"}{:rel="external "}为主题进行全局配置；而 Jekyll 并没有指定的配置方式，故主题的全局配置都挂在配置文件{:target="_blank"}{:rel="external "}中的 ksio 下面：

ksio:
  brand:
    color: "#0871ab"
  copyright:
    owner:
      text: 欧雷流
      url: https://ourai.ws/

全部配置项详见《[网站配置#模板]({{ site.baseurl }}/zh/apis/site-config/#template)》。

页面配置

即定义在 Front Matter 中的变量，可用配置项详见《[页面配置]({{ site.baseurl }}/zh/apis/page-config/)》。

在 Jekyll 中可按匹配规则为页面配置批量设置默认值{:target="_blank"}{:rel="external "}，虽 Hexo 本身不具备此机制，但本主题在一定程度上进行了模拟，需在网站配置文件{:target="_blank"}{:rel="external "}中添加：

ksio:
  defaults:
    layout: # 用于布局模板，值为对象
    page: # 用于页面，值为数组

具体用法详见《[网站配置#defaults]({{ site.baseurl }}/zh/apis/site-config/#defaults)》。