gitbook-plugin-huahe

1.0.4 • Public • Published

gitbook-plugin-huahe

使用 Katex / MathJax 解释和渲染易学盘符,包括六爻和八字。(初版只支持Katex)

在 gitbook 工程以外使用此易学函数库,请参阅华鹤易学平台通用版函数库。可以在Markdown文本编辑器,以及在独立的HTML网页中使用。支持 Katex 和 MathJax 两个渲染库。

本人同时开发了一个独立的易学案例管理平台,当前支持安卓、ios 以及在线版:

华鹤易学在线版

华鹤易学平台文档

演示网站: 《增删卜易》Gitbook (正在制作中。。。)

有疑问以及合作请联系邮箱 goldentianya@foxmail.com

函数APIhttps://maiernte.gitee.io/huahedocument/chapter6/libapi.html

安装

在Gitbook项目的配置文件 book.json 中加入插件名称 'huahe':

...
"plugins"[ ..., "huahe"],
...

然后在终端输入安装命令:

gitbook install

配置

此插件支持两种渲染方式:

  • 运行时渲染
  • 编译时渲染

编译时渲染即在编译HTML文件的时候已经把易学盘符转换成 Dom Element 。好处是浏览页面的时候会更流畅。而且当需要把Gitbook转换成其它如 pdf 或者 epub 格式的电子书时,也必须用这种方式。

而运行时渲染是指当用户浏览网站的时候,才将易学公式转换成 Dom Element。浏览设备的运算能力不够快的时候,会出现卡顿的情形。好处是它会在手机浏览时,自动采用简短名称的显示方式。

运行时渲染

在Gitbook项目的配置文件 book.json 中加入:

"pluginsConfig"{
  "huahe": { 
    "字体大小": 5, // 1~9 
    "水土共长生": true, //
    "华鹤八字正偏财": true,  //使
    "开启短名": false, //使->
    "Katex": true
  }
}
编译时渲染

需要进入目录 node_modules/gitbook-plugin-huahe 并打开 index.js 文件,搜索变量并设置为false

const runtimeRender = false

需要改变字体大小

globalSetting['size'] = SizeDef[3]

Package Sidebar

Install

npm i gitbook-plugin-huahe

Weekly Downloads

0

Version

1.0.4

License

MIT

Unpacked Size

2.08 MB

Total Files

86

Last publish

Collaborators

  • maiernte