hexo-theme-arknights

1.2.3 • Public • Published

hexo-theme-arknights

多国语言Readme

日本語バージョン

预览

如果使用了这个主题,欢迎在这儿贴预览链接~

主题预览图片

安装

一键下载

手动安装

根据需要执行以下代码

hexo init Hexo
cd Hexo
npm install -g cnpm --registry=https://registry.npm.taobao.org
cnpm install
git clone https://github.com/Yue-plus/hexo-theme-arknights.git themes/arknights

安装依赖

npm 用户:

cnpm install hexo-server hexo-browsersync hexo-renderer-pug hexo-renderer-sass hexo-renderer-ts --save

yarn 用户:

yarn add hexo-server hexo-browsersync hexo-renderer-pug hexo-renderer-sass hexo-renderer-ts

hexo-renderer-sass 很可能会安装失败,请多试几次。

修改配置文件

  • 参照 Hexo 官网 修改 Hexo/ 目录下的 _config.yml

    • theme: 的值改为 arknights
    • 开启代码高亮:
      highlight:
        hljs: true
  • 查看 Hexo/themes/arknights/目录下的 _config.yml

    建议参考:使用代替主题配置文件

    主题的配置文件可参照中文注释修改。

修改资源文件

可按需修改 Hexo/themes/arknights/source/ 目录下的

  • favicon.ico:浏览器标签页上的图标
  • CNAME: GitHub Pages 部署时的自定义域名
  • README.md: 部署仓库的 README
  • img/目录下的 Alipay.pngWeChat.png 可替换为自己的二维码; 1:1 比例的 png 图片;

写作

  • 可参考 Hexo | 写作
  • 在主题仓库的 Hexo 分支有一些示例文本可以取用
  • 添加文章标签与分类,更多特性可参考 Hexo | Front-matter ,示例:
    ---
    title: 'Hello World !'
    date: 2020-04-15 21:54:02
    tags: code
    category: Example
    ---
  • <!-- more --> 之前的内容称之为摘要,会显示在首页上,并且可以设置是否也在正文显示。

顶部导航栏新建自定义页面

  • 例如:新建一个 about 页面 在 Hexo 目录下执行
    hexo new page 'about'
    然后 Hexo/source/ 目录下会多一个 about 文件夹
  • 编辑 Hexo/source/about/index.md 文件
  • 编辑主题目录下的 _config.yml,添加一个链接:
    menu:
      About: /about

评论系统

本主题支持Valine 。 请修改主题目录下 _config.yml 文件中 valine:app_id:app_key:

参考 Valine 快速开始

开启邮件提醒:zhaojun1998 / Valine-Admin

数学公式

使用 hexo-filter-mathjax Hexo 过滤器来显示数学公式:

  1. 在 Hexo 目录下执行以下指令:
# 安装 hexo-filter-mathjax 插件
cnpm install hexo-filter-mathjax --save
# 清除缓存
hexo clean
  1. 把以下内容添加到 <Hexo>/_config.yml 文件:
mathjax:
  tags: none # 或 'ams' 或 'all'
  single_dollars: true # 启用单个美元符号作为内联(行内)数学公式定界符
  cjk_width: 0.9 # 相对 CJK 字符宽度
  normal_width: 0.6 # 相对正常(等宽)宽度
  append_css: true # 将 CSS 添加到每个页面
  every_page: false # 如果为 true,那么无论每篇文章的前题中的 `mathjax` 设置如何,每页都将由 mathjax 呈现
  1. 在需要启用 mathjax 的文章的 Front-matter 区内添加 mathjax: true
---
title: On the Electrodynamics of Moving Bodies
categories: Physics
date: 1905-06-30 12:00:00
mathjax: true
---

然后,就可以在文章中使用 LaTeX 语法。

  1. 需要注意,内联数学公式(…… $<数学公式>$ ……)在开头 $ 之后和结尾 $ 之前不能有空格!例如:
-$ \epsilon_0 $
+$\epsilon_0$
-$ \frac{\partial}{\partial t} $
+$\frac{\partial}{\partial t}$
  1. 需要注意 LaTeX 与 Markdown 语法之间的冲突。如有必要,请使用 \ 进行转义:
-$\epsilon_0$
+$\epsilon\_0$
-\begin{eqnarray*}
+\begin{eqnarray\*}

也可以尝试更换能更好处理数学公式的渲染器 hexo-renderer-pandoc

图表支持

修改 主题文件夹 下的 _config.yml 文件,将 mermaid: 设为 true

主题通过 mermaid-js 绘制各种图表。查看示例

支持:

Front-matter

除了 Hexo 支持的 Front-matter

还支持:

# 文章页右上角发布/更新日期
post-info: true/false

# 侧边栏的目录
post-index: true/false

# 打赏框
reward: true/false

参与开发

开发人员

欢迎提交 IssuesPR

分支说明

分支 说明
master 主题开发目录
gh-pages gh-page 托管
hexo Hexo 目录,这里有可以用于测试主题的 .md 文件

搭建开发环境

先装好 nodejsyarn ,然后执行以下命令:

yarn global add hexo-cli yo generator-hexo-theme
git clone -b hexo https://github.com/Yue-plus/hexo-theme-arknights.git
cd hexo-theme-arknights
git clone https://github.com/Yue-plus/hexo-theme-arknights.git themes/arknights
yarn install
hexo serve --debug

开发中可能遇见的 BUG 及解决方法

修改 .pug 模板文件无法自动刷新页面。

解决方法:将 Hexo 目录下的 ./node_modules/hexo-renderer-pug/lib/pug.js 中的 pugRenderer.compile = pugCompile; 注释掉。

运行 ‘hexo serve --debug’ 时,长文章渲染不全

这是由热重载插件 hexo-browsersync 导致的,不会影响发布 解决方法:禁用该插件。(反正不影响发布,不管也行)

参与开发可能需要的文档

支援主题开发

喜欢这个主题的话可以:

  • 给颗小星星吧 (/▽\)
  • 开发者的B服ID:YuePlus#6221
  • 加入 QQ 群:618221514

    群内开发为主,吹水晒卡,分享线索7也都欢迎哦~ d=====( ̄▽ ̄*)b

  • 打赏、赞助:

收款二维码

Readme

Keywords

none

Package Sidebar

Install

npm i hexo-theme-arknights

Weekly Downloads

8

Version

1.2.3

License

MIT

Unpacked Size

1.6 MB

Total Files

43

Last publish

Collaborators

  • yue_plus