CeTZ 项目教程
1. 项目目录结构及介绍
CeTZ 项目的目录结构如下:
cetz/
├── common/
├── docs/
├── gallery/
├── src/
├── tests/
├── .editorconfig
├── .gitignore
├── .gitmodules
├── CHANGES.md
├── LICENSE
├── README.md
├── justfile
├── requirements.typ
├── typst.toml
目录介绍
- common/: 包含项目通用代码或资源文件。
- docs/: 包含项目的文档文件。
- gallery/: 包含项目的示例图库。
- src/: 包含项目的主要源代码。
- tests/: 包含项目的单元测试代码。
- .editorconfig: 编辑器配置文件,用于统一代码风格。
- .gitignore: Git 忽略文件配置。
- .gitmodules: Git 子模块配置文件。
- CHANGES.md: 项目变更日志。
- LICENSE: 项目许可证文件。
- README.md: 项目介绍和使用说明。
- justfile: 项目命令运行配置文件。
- requirements.typ: 项目依赖配置文件。
- typst.toml: Typst 项目配置文件。
2. 项目启动文件介绍
CeTZ 项目的启动文件主要是 src/
目录下的源代码文件。具体启动文件需要根据项目的具体实现来确定。通常,Typst 项目的启动文件是 typst.toml
,它包含了项目的配置信息和依赖项。
3. 项目的配置文件介绍
typst.toml
typst.toml
是 CeTZ 项目的主要配置文件,包含了项目的依赖项和构建配置。以下是一个示例配置文件的内容:
[dependencies]
cetz = "0.2.2"
[build]
output = "output.pdf"
justfile
justfile
是项目命令运行配置文件,用于定义项目的各种命令和脚本。以下是一个示例 justfile
的内容:
install:
typst install
test:
typst test
requirements.typ
requirements.typ
是项目的依赖配置文件,用于指定项目所需的依赖项。以下是一个示例 requirements.typ
的内容:
#import "@preview/cetz:0.2.2"
通过以上配置文件,可以方便地管理和构建 CeTZ 项目。