Universe
Create project in app

www.中国科学技术大学.com

为了降低新手上路的代码分析成本以及降低项目的耦合性，特将项目拆分成多个typ文件，请按以下步骤了解：

main.typ是渲染的入口，新手上路直接从这里开始。//第一步

main.typ中导入了config.typ，这是配置文件，封面的标题，副标题，作者等信息在这里修改，其他你无须烦恼。//第二步

config.typ中导入了theme.typ和lib.typ，新手上路可以暂时跳过。

  • theme.typ相当于CSS,控制着模板长什么样，如果你对模板的样式不满意，包括字体，图片素材，跳转功能，或者改成其他学校的主题，在这里修改成你希望的样子。学习曲线较陡峭，初学者无需关心，
  • lib.typ中是第三方包和自定义函数，当模板中的包不能满足你的需求，或者想自定义一些常用函数，请把它们放在这里以保持项目的结构性和低耦合。

content.typ这是你放实际内容的地方，一级标题是大纲，二级标题是当页的标题，之后的n级标题都在页内作为内容显示，无特殊地位。//第三步

  • assets: 模板资源文件

    • img: 模板图片文件

  • template: 可复用组件

    • []

  • config.typ : 配置文件，包括封面的信息在这里。

  • content.typ : 只需在此处添加内容

  • lib.typ : 库文件，导入第三方库请在这导入

  • main.typ : 编译入口，导入第三方库时有可能需要把#show放在此处

  • theme.typ : 主题文件，可自行修改样式

  1. vscode下载插件Typst LSP,Tinymist Typst,Typst Sync。
  2. 打开本项目，在main.typ中点击preview。若在content.typ中点击preview，则预览类似markdown的文档排版。
  1. 在使用时，config.typ 应作为顶层文件被其他文件导入，避免交叉导入。

有空再写代码注释