Introduce tech-report/ with cover page, custom TOC, and summary flow; add travel-plan/ for trip planning; update README, gitignore, and brand colors. Co-authored-by: Cursor <cursoragent@cursor.com>
52 lines
1.8 KiB
Markdown
52 lines
1.8 KiB
Markdown
# Tech Report · 技术报告模板
|
||
|
||
GreLin 技术报告 Typst 模板,正文版式参考 [metropole-report](https://typst.app/universe/package/metropole-report);**封面**为自定义深蓝渐变 + 光斑 / 波纹 / 斜向色带(见 `data/cover.typ`)。
|
||
|
||
## 快速开始
|
||
|
||
1. 编辑 [`content/report.md`](content/report.md)
|
||
2. 打开 [`report.typ`](report.typ) 预览或导出 PDF
|
||
|
||
```bash
|
||
typst compile tech-report/report.typ tech-report/sample.pdf --root .
|
||
```
|
||
|
||
## 目录结构
|
||
|
||
| 文件 | 说明 |
|
||
|------|------|
|
||
| [`content/report.md`](content/report.md) | **主编辑入口**:YAML 元数据 + 正文 |
|
||
| [`content/assets/`](content/assets/) | 图片资源 |
|
||
| [`data/config.typ`](data/config.typ) | 默认公司名、标题等 |
|
||
| [`data/theme.typ`](data/theme.typ) | 字号、行距、GreLin 品牌色 |
|
||
| [`data/cover.typ`](data/cover.typ) | 封面装饰与版式 |
|
||
| [`data/metropole-grelin.typ`](data/metropole-grelin.typ) | 正文 metropole 壳(跳过内联标题) |
|
||
| [`report.typ`](report.typ) | 编译入口 |
|
||
|
||
## YAML 元数据
|
||
|
||
```yaml
|
||
---
|
||
title: 某某矿山智能分选技术报告
|
||
brand: GreLin
|
||
company: 西安高岭绿能科技有限公司
|
||
date: 2026-06-22
|
||
version: v1.0
|
||
summary: |
|
||
摘要正文……
|
||
---
|
||
```
|
||
|
||
## 依赖
|
||
|
||
| 包 | 用途 |
|
||
|----|------|
|
||
| [metropole-report](https://typst.app/universe/package/metropole-report) | 报告版式(封面、标题、表格、列表) |
|
||
| [cmarker](https://typst.app/universe/package/cmarker) | Markdown → Typst |
|
||
| [codly](https://typst.app/universe/package/codly) | 代码块高亮 |
|
||
| [glossarium](https://typst.app/universe/package/glossarium) | 术语表 |
|
||
|
||
## 样式参考
|
||
|
||
整体风格对齐 `typst init @preview/metropole-report:0.1.0`;后续可引入 [grape-suite](https://typst.app/universe/package/grape-suite) 做更复杂的学术组件。
|