35 lines
1.5 KiB
Markdown
35 lines
1.5 KiB
Markdown
# GreLin · Typst 文档模板
|
||
|
||
GreLin 内部 Typst 模板库，按文档类型分目录维护。
|
||
|
||
## 目录
|
||
|
||
| 文件夹 | 说明 | 入口文件 |
|
||
|--------|------|----------|
|
||
| [`resume/`](resume/) | 团队简历 | `cv.typ` |
|
||
| [`feasibility/`](feasibility/) | 可行性研究报告 | `report.typ` |
|
||
|
||
## 环境要求
|
||
|
||
- [VS Code](https://code.visualstudio.com/) 或 [Cursor](https://cursor.com/)
|
||
- 扩展：[Tinymist](https://marketplace.visualstudio.com/items?itemName=myriad-dreamin.tinymist)（搜索 `Tinymist` 安装即可，已集成预览与导出，无需单独装 Typst CLI）
|
||
|
||
> 勿安装已废弃的 `Typst LSP`、`Typst Preview`，会与 Tinymist 冲突。
|
||
|
||
## 快速开始
|
||
|
||
1. 用 VS Code / Cursor 打开本仓库
|
||
2. 打开要编辑的入口文件，例如 `resume/cv.typ`
|
||
3. **看效果（预览）**：`Ctrl+Shift+P` → 输入 `Typst Preview` → 回车；侧边会实时显示排版效果（快捷键 `Ctrl+K` 然后 `V`）
|
||
4. **导出 PDF**：`Ctrl+Shift+P` → 输入 `Typst Export PDF` → 回车；PDF 默认生成在同目录（如 `resume/sample.pdf`）
|
||
|
||
仓库根目录的 [`typst.toml`](typst.toml) 将项目根设为 GreLin，以便 `resume/` 与 `feasibility/` 共享 [`brand/colors.typ`](brand/colors.typ)。命令行编译示例：
|
||
|
||
```bash
|
||
typst compile resume/cv.typ resume/sample.pdf --root .
|
||
```
|
||
|
||
已填好的示例 PDF 见 [`resume/sample.pdf`](resume/sample.pdf)。
|
||
|
||
不熟悉 Typst？可参考社区维护的 [小蓝书（Typst 中文教程）](https://tutorial.typst.dev/)；英文版见 [官方入门教程](https://typst.app/docs/tutorial/)。
|