CTAN Comprehensive TeX Archive Network

Directory language/chinese/luatex-cn

README.md

Lua-CN

English Version

致力于基于 Lua 引擎实现最纯粹、最高质量的中文排版支持。已完成对常见古籍版式的像素级复刻,能够直观地处理版心、夹注、侧批、眉批、脚注、印章、句读、改字、标点等等功能。同时支持现代繁体竖排,支持大陆与台湾不同标点标准。灵活支持用户自定义模板。

CTAN: v0.3.1 | GitHub Release: v0.3.1

Wiki 用户手册快速入门命令索引更新日志

排版效果展示

古籍排版 - 四库全书·文渊阁本

四库全书目录史记
《四库全书简明目录》 — 抬头、夹注、缩进 《史记·五帝本纪》 — 印章、夹注、乌丝栏
源码PDF 源码PDF

手抄本 -《红楼梦》甲戌本

红楼梦2红楼梦1
第二页(标点) 第一页(眉批)
查看源码 | 查看 PDF

现代繁体竖排 -《史记·秦楚之际月表》

卷十六第二页卷十六第一页
第二页 第一页
查看源码 | 查看 PDF

更多示例请查看 示例目录Wiki 示例页

5 分钟快速开始

第一步:安装 发行版

如果你还没有安装 环境,需要先安装 Live(推荐 2024 或更新版本):

系统 安装方式
Windows 下载 Live 安装包,运行 install-tl-windows.exe
macOS 下载 Mac,双击安装
Linux sudo apt install texlive-full(Ubuntu/Debian)或 sudo dnf install texlive-scheme-full(Fedora)
详细指引请参阅 Wiki 安装指南

第二步:安装 luatex-cn

推荐从 GitHub Release 下载最新版本的 luatex-cn-tex-v*.zip,解压后将 tex/ 下的内容放入:

~/texmf/tex/latex/luatex-cn/          (macOS/Linux)
C:\Users\<用户名>\texmf\tex\latex\luatex-cn\  (Windows)

然后运行 texhash 刷新。

也可以通过包管理器安装(CTAN 版本可能落后):

tlmgr install luatex-cn

第三步:编译你的第一个古籍

创建 test.tex,写入以下内容:

\documentclass[四库全书]{ltc-guji}
\句读模式
%\设置字体{TW-Kai}

\title{钦定四库全书}
\chapter{史记\\卷一}

\begin{document}
\begin{正文}
黄帝者,少典之子,姓公孫,名曰軒轅。\夹{生而神靈,弱而能言,幼而徇齊,長而敦敏,成而聰明。}
\end{正文}
\end{document}

使用 lualatex 编译(注意不是 pdflatexxelatex):

lualatex test.tex

编译成功后打开 test.pdf,你将看到一个完整的古籍竖排页面。

接下来请查看 Wiki 快速入门 了解更多命令用法,或浏览 命令索引 查看全部命令。

功能特性

功能 说明 Wiki 文档
竖排引擎 基于网格的高精度竖排文本流,支持自动分列分页 快速入门
版心与鱼尾 单鱼尾/双鱼尾、乌丝栏、四周双边 模板
夹注 双栏小注自动平衡、跨列跨页 夹注
侧批/眉批 行间侧批、页面顶部眉批 批注
句读 传统句读/现代标点/白文三种模式切换 句读
印章 电子印章绝对定位,支持透明度 印章
改字与装饰 古籍勘误、专名号、书名号、着重号 改字与装饰
抬头 单抬/双抬/三抬/平抬,自动边框包裹 抬头
现代标点 标点挤压、禁则处理、大陆/台湾风格 标点系统
脚注 段末注/页下注,鹿角/带圈编号 脚注
模板系统 内置四库全书、红楼梦甲戌本、中华书局等预设 模板
字体管理 跨平台自动探测、字体族递补(Fallback) 字体设置
调试工具 网格可视化、坐标标尺、模块级日志 调试模式

三个文档类

文档类 用途 示例
ltc-guji 传统古籍排版(版心、鱼尾、丝栏) \documentclass{ltc-guji}
ltc-cn-vbook 现代大陆竖排书籍 \documentclass{ltc-cn-vbook}
ltc-tw-vbook 现代台湾竖排书籍 \documentclass{ltc-tw-vbook}
所有命令都支持简体、繁体中文名称。例如 \夹注{...}\侧批{...}\begin{正文}

模板

除了默认模板,luatex-cn 支持自定义模板。欢迎贡献新的模板!请将模板文件放在 模板目录 并提交 Pull Request。推荐模板:

模板 说明 源码
四库全书文渊阁本 八行二十一字,正文首页带"文渊阁宝"印章,目录封面黄底,页面淡黄背景 cfg

在文档中使用模板:

\documentclass[四库全书文渊阁本]{ltc-guji}
\begin{document}
  ...
\end{document}

系统要求

  • Lua(推荐 Live 2024+)
  • luaotfloadfontspec Live 自带)
  • 中文字体(系统通常已自带,推荐思源宋体或楷体以获得最佳古籍效果)

路线图

  • 已完成:古籍竖排,版心,夹注,侧批,眉批,脚注,印章,句读,改字,现代标点系统,模板系统等
  • v0.2.x:完善现代繁体竖排,完整排版更多古籍
  • v0.3.0:完善文档体系,支持简繁命令,准备更大范围推广

文档与社区

联系人: Sheldon Li | 邮件: sheldonli.dev@gmail.com

开发与测试

如果你希望参与开发或在本地测试源码更改,请参考 开发者指南Wiki 开发文档

许可证

Apache License 2.0

Download the contents of this package in one zip archive (19.7M).

Lua-CN – A Lua based package to handle Chinese text typesetting

A Lua package for Chinese character typesetting, covering horizontal/vertical, traditional/modern layout. Currently focus on Ancient Book replication. Implemented core logic of vertical typesetting, decorative elements of traditional Chinese books, and interlinear notes.

PackageLuaTeX-CN
Bug trackerhttps://github.com/open-guji/luatex-cn/issues
Repositoryhttps://github.com/open-guji/luatex-cn
Version0.3.1
LicensesApache License, version 2.0
Copyright2026 Open-Guji
MaintainerSheldon Li
Contained inTeX Live as luatex-cn
MiKTeX as luatex-cn
TopicsChinese
Class
Lua
...
Guest Book Sitemap Contact Contact Author