# hiker **Repository Path**: mossflower/hiker ## Basic Information - **Project Name**: hiker - **Description**: Hiker is a Chinese ancient books auto typesetting tool. Hiker 致力于中文古籍自动排版。 - **Primary Language**: Rust - **License**: MIT - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2025-11-18 - **Last Updated**: 2026-02-04 ## Categories & Tags **Categories**: Uncategorized **Tags**: deprecated ## README # Hiker **注:由于 Rust 生成 PDF 的库在自定义中文字体时大多存在 BUG, 而我在自己实现的过程中(参见 dev 分支)发现此事确实有些复杂,故改用无头浏览器由 HTML 转 PDF 的方案。 新的实现移步:https://gitee.com/scaredcrow/mirage )** Hiker 致力于中文古籍自动排版。 ![demo.png](demo.png) ## 使用方法 `hiker -i 'your_input_file.txt'` 该 CLI 工具可以将无格式的普通文本输入文件自动转为古籍排版。文本输入文件遵循后续介绍的标记语法, 同时,还可以为其指定版式信息,调整其显示的样式。 使用 `hiker -h` 显示全部使用方法: TODO ## 版式标记语法 版式信息均为可选项,数字单位为 **点(points)** ,1点 = 1/72英寸 ≈ 0.3528毫米。 完整的配置信息如下,当与书籍文本内容放在同一个输入文件时,其中首行的 `---- 版式 ----` 必须包含。 ``` ---- 版式 ---- [版框] 3 四周双边 # 线宽,四周单边/四周双边/左右双边 [栏线] 直线 # 直线/卍字栏/竹节栏/博古栏/花栏 [界行] 0.5 乌丝栏 # 界行线宽,乌丝栏或朱丝栏 [行款] 12 18 # 半叶 X 行,行 Y 字 [天头] 100 # 天头的高度 [地脚] 60 # 地脚的高度 [边距] 93 93 # 左边、右边的宽度 [版心] 40 270 # 版心的宽度、高度 [象鼻] 3 # 象鼻线的宽度,为 0 则无 [鱼尾] 2 # 鱼尾的类型编号 [书耳] 0 # 书耳线的宽度,为 0 则无;蝴蝶装常用 [句读] 无 # 有/无 [尺寸] 842 595 # 页面宽高,默认 A4 ``` ## 文本标记语法 示例如何标记书籍的文本内容: ``` ---- 内容 ---- [书名] 古典小说集 [篇名] 续齐谐记 [作者] 梁 吴均 撰 / 明 吴琯 校 [版心] 古典小说集 (1) [正文] 这里是正文。 这里是正文第二段。 [补图] [1] abc.png [2] 123.jpg ``` 多个 `[作者]` 时用 `/` 分隔。作者信息依次为:朝代、姓名、撰或校等字样, 其中姓名不可为空。 `[补图]` 是为了当正文中缺失某些文字时,使用图片来代替,可将补图的序号放在正文对应的位置,如正文: > 中國人真牛[1],哈哈! 并提供补图(路径可自定义): > [1] b.jpg 另外,也可以在正文中使用 `[空]`,将当前汉字的位置空出来,打印后自行手写补足。 ## 目前进度 - [x] 版框线宽调整 - [x] 版框四周单边 - [x] 版框四周双边 - [x] 版框左右双边 - [x] 栏线直线 - [ ] 栏线卍字栏 - [ ] 栏线竹节栏 - [ ] 栏线博古栏 - [ ] 栏线花栏 - [x] 界行线宽 - [x] 乌丝栏 - [x] 朱丝栏 - [x] 行款 - [x] 天头 - [x] 地脚 - [x] 边距 - [x] 版心 - [x] 象鼻 - [x] 鱼尾 1、2 - [ ] 书耳 - [ ] 句读 - [x] 尺寸 - [ ] 补图