# mirage

**Repository Path**: scaredcrow/mirage

## Basic Information

- **Project Name**: mirage
- **Description**: mirage 致力于中文古籍自动排版。
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2026-01-27
- **Last Updated**: 2026-02-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Mirage 

Mirage 致力于中文古籍自动排版。

![demo.png](demo.png)

## 使用方法

`mirage -i 'your_input_file.txt'`

该 CLI 工具可以将无格式的普通文本输入文件自动转为古籍排版。文本输入文件遵循后续介绍的标记语法，
同时，还可以为其指定版式信息，调整其显示的样式。

使用 `mirage -h` 显示全部使用方法。

## 文本标记语法

示例如何标记书籍的文本内容：

```
[书名] 古典小说集
[篇名] 续齐谐记
[作者] 梁 吴均 撰 / 明 吴琯 校
[版心] 古典小说集 (1)
[正文]
漢宣帝以皂蓋車一乘，賜大將軍霍光，悉以金鉸具。至夜，車轄上金鳳皇輒亡去，莫知所之，至曉乃還。如此非一，守車人亦嘗見。後南郡黄君仲北山羅鳥，得鳳皇，入手即化成紫金，毛羽冠翅，宛然具足，可長尺餘。守車人列上云：「今月十二日夜，車轄上鳳凰俱飛去，曉則俱還。今則不返，恐爲人所得。」光甚異之，具以列上。後數日，君仲詣闕上鳳皇子，云：「今月十二夜，北山羅鳥所得。」帝聞而疑之，置承露盤上，俄而飛去。帝使尋之，直入光家，止車轄上，乃知信然。帝取其車，每遊行即乘御之。至帝崩，鳳皇飛去，莫知所在。[注：嵇康詩云：「翩翩鳳轄，逢此網羅。」]
京兆田真，兄弟三人，共議分財，生貲皆平均。惟堂前一株紫荆樹，共議欲破三片。明日就截之，其樹即枯死，狀如火燃。真往見之，大驚，謂諸弟曰：「樹本同株，聞將分斫，所以顦顇，是人不如木也。」因悲不自勝，不復解樹，樹應聲榮茂。兄弟相感，合財寶，遂爲孝門。真仕至太中大夫。[注：陸機詩云：「三荆歡同株。」]
弘農楊寶性慈愛，年九歲，至華陰山，見一黄雀爲鴟梟所搏，逐樹下，傷瘢甚多，宛轉復爲螻蟻所困。寶懷之以歸，置諸梁上，夜聞啼聲甚切，親自照視，爲蚊所嚙，乃移置巾箱中，啖以黄花。逮十餘日，毛羽成，飛翔，朝去暮來，宿巾箱中。如此積年，忽與群雀俱來，哀鳴遶屋，數日乃去。是夕，寶三更讀書，有黄衣童子曰：「我王母使者，昔使蓬萊，爲鴟梟所搏，蒙君之仁愛見救，今當受賜南海。」别以四玉環與之，曰：「令君子孫潔白，且從登三公事如此環矣。」寶之孝大聞天下，名位日隆。子震，震生秉，秉生彪，四世名公。及震葬時，有大鳥降，人皆謂真孝昭也。[注：蔡邕論云：昔日黄雀報恩而至。]
```

### [作者]
作者信息依次为：朝代、姓名、“撰”或“校”等字样，多个 `[作者]` 时用 `/` 分隔。其中，姓名不可为空。

### [版心]
版心中，文字后面的括号中可以指定起始页码数。通常，单册时指定为 `1` 即可，该功能主要用于多册丛书想保持页码连续的情况。

### [正文]
正文一节请换行区分段落。正文可以使用简体、繁体，也可以包含标点，最终均会生成无标点的繁体字版本。
正文中可以添加 `[空]`，以备某些文字字体库中不存在，此时会将当前汉字的位置空出来，打印后自行手写补足。

### [补图]
`[补图]` 是为了当正文中缺失某些文字时，使用图片来代替，可将补图的序号放在正文对应的位置，如正文：

> 中國人真牛[1]，哈哈！

并提供补图(路径可自定义)：

> [1] b.jpg

## TODOs

- [ ] 字体文件压缩，减小 bin 体积
- [ ] 单一文件出错时，继续解析其它
- [ ] 补图文件路径健壮性处理
- [ ] 增加首页样式
- [ ] -t 参数，自动生成输入文件模板