快速上手

在开始之前

写在前面

受制于开发组的时间问题，本文档肯定会有诸多不完善之处，为了给用户一个良好的 Blogging 体验，若您已对 Hexo 及 ShokaX 有一定了解且您有协助修改文档的意愿，欢迎您发起 Pull Request。

在开始之前，你应该已经安装了如下软件：

• Node.js 18 以上
• hexo-cli 的 latest 版本

ShokaX-CLI 目前版本不负责处理 hexo 环境，请自行 hexo init。

安装主题

使用 ShokaX-CLI

安装 ShokaX-CLI:

npm

# hexo init
npm install shokax-cli --location=global
# cd your_blog
SXC install shokaX

pnpm

# hexo init
pnpm add shokax-cli --location=global
# cd your_blog
SXC install shokaX

手动安装

注意

ShokaX 不建议使用手动安装，仅应该在 SXC 无法正常安装的时候手动安装

指令如下：

yarn

yarn add hexo-theme-shokax
yarn add hexo-renderer-multi-next-markdown-it
yarn add hexo-autoprefixer
yarn add hexo-algoliasearch
yarn add hexo-feed
yarn add esbuild
yarn add theme-shokax-pjax
yarn add theme-shokax-anime
yarn add lozad

pnpm

pnpm add hexo-theme-shokax
pnpm add hexo-renderer-multi-next-markdown-it
pnpm add hexo-autoprefixer
pnpm add hexo-algoliasearch
pnpm add hexo-feed
pnpm add esbuild
pnpm add theme-shokax-pjax
pnpm add theme-shokax-anime
pnpm add lozad

配置主题

注意

更改根目录 /_config.yml 中的 theme 为 shokaX (SXC 默认 origin 或 npm 安装修改为 shokax)
请注意，本主题仅在 npm 上使用的是shokax,其他情况下均为shokaX
对于 linux 等大小写敏感的系统，npm 源的 theme 必须使用shokax同时修改自定义配置文件为_config.shokax.yml

提示

以下配置均在 /_config.yml 文件中修改

markdown 配置如下：

markdown:
  render: # 渲染器设置
    html: false # 过滤 HTML 标签
    xhtmlOut: true # 使用 '/' 来闭合单标签 （比如 <br />）。
    breaks: true # 转换段落里的 '\n' 到 <br>。
    linkify: true # 将类似 URL 的文本自动转换为链接。
    typographer:
    quotes: "“”‘’"
  plugins: # markdown-it 插件设置
    - plugin:
        name: markdown-it-toc-and-anchor
        enable: true
        options: # 文章目录以及锚点应用的 class 名称，shoka 系主题必须设置成这样
          tocClassName: "toc"
          anchorClassName: "anchor"
    - plugin:
        name: markdown-it-multimd-table
        enable: true
        options:
          multiline: true
          rowspan: true
          headerless: true
    - plugin:
        name: ./markdown-it-furigana
        enable: true
        options:
          fallbackParens: "()"
    - plugin:
        name: ./markdown-it-spoiler
        enable: true
        options:
          title: "你知道得太多了"

autoprefixer:
  exclude:
    - "*.min.css"

停用默认代码高亮（<=6.3.0）:

highlight:
  enable: false

prismjs:
  enable: false

停用默认代码高亮（>=7.0.0-rc1）：

syntax_highlighter: false

注意

在 0.2.5 及以下的版本中，如果您把 ShokaX 网站部署到了 cloudflare CDN 支持的服务上，请关闭 rocket-loader ，此功能与 ShokaX 的 page.ts 存在冲突，会导致页面在 loading 时卡死。
0.2.6 已修复此问题，可开启 rocket-loader 功能。

现在 shokaX 已经可以正常运行了，hexo s 即可。