Skip to content

Latest commit

 

History

History
150 lines (107 loc) · 2.83 KB

README_zh.md

File metadata and controls

150 lines (107 loc) · 2.83 KB

Typst note template

简体中文 English

封面 目录 正文 参考文献
Cover Contents Main Body Bibliography

简单且实用的 Typst 笔记模板

xyznote 是一个专为 Typst 设计的模板，旨在帮助用户记录高效且有组织的笔记。它提供了一个干净且直接的结构，使得记录和整理想法变得更加简单。

使用

#import "@preview/xyznote:0.3.0": *

#show: xyznote.with(
  title: "xyznote",
  author: "wardenxyz",
  abstract: "A simple typst note template",
  createtime: "2024-11-27",
  lang: "zh",
  bibliography-style: "ieee",
  preface: [], //注释这一行删除序页
  bibliography-file: bibliography("refs.bib"), //注释这一行删除参考文献页面
)

功能特性

  • PDF 元数据：包含标题、作者和日期字段。

  • 目录：自动生成的目录（ToC），便于在文档中导航。

  • 引用（可选）：一个专门用于引用来源和参考文献的部分。仅在需要时包含此部分。

自定义样式

#tipbox[
  contents
]
#markbox[
  contents
]
#sectionline
This is #highlight(fill: blue.C)[highlighted in blue].

This is #highlight(fill: yellow.C)[highlighted in yellow].

This is #highlight(fill: green.C)[highlighted in green].

This is #highlight(fill: red.C)[highlighted in red].
#brainstorming[
  This is a brainstorming.
]
#definition[
  This is a definition.
]
#question[
  This is a question.
]
#task[
  This is a task.
]
#brainstorming(lang: "zh")[
  This is a brainstorming.
]
#definition(lang: "zh")[
  This is a definition.
]
#question(lang: "zh")[
  This is a question.
]
#task(lang: "zh")[
  This is a task.
]

在 VSCode 中编辑（推荐）

  1. 在 VS Code 中安装 Tinymist Typst 扩展，它提供了语法高亮、错误检查和 PDF 预览功能。

  2. 开始项目

typst init @preview/xyznote:0.3.0
cd xyznote
code .

  1. 按 Ctrl+K V 打开 PDF 预览

  2. 点击 Typst 文件顶部的 Export PDF 导出 PDF。

在 Webapp 中编辑

点击右侧的 Create project in app 按钮，在 Webapp 内编辑。

鸣谢

以下项目为本项目的开发提供了关键的灵感和重要的代码贡献。

https://github.com/gRox167/typst-assignment-template

https://github.com/DVDTSB/dvdtyp

https://github.com/a-kkiri/SimpleNote

https://github.com/spidersouris/touying-unistra-pristine