让 Typst 更懂中文,提供优雅、易用的 Typst 中文排版解决方案。
Typst 是一个新兴的、基于标记语言的排版系统,它旨在提供与 LaTeX 相媲美的强大功能,同时拥有更简洁的语法和更快的编译速度。CTypst (Chinese Typst Support) 项目的创立灵感来源于 LaTeX 世界中广受欢迎的 CTex 宏集/发行版,致力于为 Typst 用户提供全面、便捷、高质量的中文排版支持。
我们的目标是让中文用户能够轻松地使用 Typst 创作出符合中文排版习惯和审美标准的各类文档,无论是学术论文、书籍、报告还是演示文稿。
Note
CTypst 目前处于开发阶段,对于下方列出的特性,不保证有 100% 完善的支持。
CTypst 项目计划提供以下核心功能和特性:
- 📝 中文文档模板 (Chinese Document Templates):
- 提供常用的中文文档模板,如:
- 学术论文 (符合国标或常见高校要求的格式)
- 书籍 (Book)
- 演示文稿 (Presentation)
- 简历 (Resume)
- 信函 (Letter)
- 报告 (Report)
- 提供常用的中文文档模板,如:
- 🖋️ 中文字体支持 (Chinese Font Support):
- 简化中文字体配置流程,方便用户指定和切换常用中文字体(如宋体、黑体、楷体、仿宋等)。
- 预设对常见开源中文字体(如思源宋体、思源黑体、霞鹜文楷等)的良好支持。
- 提供中西文混排时的字体选择和优化方案。
- 📐 中文排版规范 (Chinese Typesetting Conventions):
- 实现符合国家标准的中文标点符号用法、避头尾规则及行尾处理。
- 段首缩进、行距、段距等符合中文阅读习惯的默认设置。
- 针对中文优化的标题样式、列表样式、图表标题和编号等。
- 支持中文特有的排版元素,如着重号、专名号等(视 Typst 能力而定)。
- 🧩 实用宏与函数 (Utility Macros & Functions):
- 提供方便中文排版的辅助命令,例如中文序号、日期格式化、农历日期、章节名汉化等。
- 页眉页脚的定制,符合中文习惯的页码样式(如 “第 X 页 / 共 Y 页”)。
- 参考文献和索引的中文支持优化。
- 📚 详细文档与教程 (Documentation & Tutorials):
- 提供清晰的中文使用文档、API 参考和入门教程。
- 收集和撰写 Typst 中文排版技巧和最佳实践。
- 💬 社区支持 (Community Support):
- 建立中文 Typst 用户交流社区,分享经验,解决问题,共同推动 Typst 在中文领域的发展。
本项目采用 GNU Lesser General Public License v2.1 (LGPL-2.1) or later 许可证,具体到每个分包可能有所不同。这意味着:
- 您可以自由地:
- 使用 (Use): 在您的任何 Typst 项目(无论是开源还是闭源)中使用本模板。
- 分发 (Distribute): 分发本模板的原始版本或您修改后的版本。
- 修改 (Modify): 修改本模板的源代码。
- 在以下条件下:
- 共享修改 (Share Alike for Modifications to the Library): 如果您修改了本项目的源代码 (
lib.typ或其他核心文件),并且您选择分发这个修改后的版本,那么这个修改后的版本也必须在 LGPL-2.1 or later 或 GPL-3.0 许可下提供。 - 声明和版权 (Notice and Copyright): 您必须保留原始的版权声明和许可证文本。
- 提供源码 (Source Code Provision): 如果您分发包含本模板(或其修改版)的二进制或编译形式(例如,作为一个更大的应用程序的一部分),您需要提供一种方式让接收者能够获取模板的源代码。对于 Typst 模板,这通常意味着分发
.typ文件本身即可满足要求。
- 共享修改 (Share Alike for Modifications to the Library): 如果您修改了本项目的源代码 (
- 请注意:
- 链接不“传染” (No "Viral" Effect on Your Project): 仅仅在您的 Typst 文档或项目中通过
#import使用本模板,并不会强制要求您的整个文档或项目也必须采用 LGPL-2.1 or later 许可证。您可以为您的最终文档(例如生成的 PDF)或包含您文档的项目选择任何您希望的许可证。
- 链接不“传染” (No "Viral" Effect on Your Project): 仅仅在您的 Typst 文档或项目中通过
- Typst 团队: 感谢他们开发了如此优秀和富有潜力的排版工具 (Typst GitHub)。
- CTex 项目: 为本项目提供了重要的灵感和参照 (CTex GitHub)。
- 所有未来的贡献者和用户: 感谢社区的每一个成员!