Typst-Fletcher 项目使用教程

Typst-Fletcher 项目使用教程

typst-fletcher Typst package for drawing diagrams with arrows, built on top of CeTZ. 项目地址: https://gitcode.com/gh_mirrors/ty/typst-fletcher

1. 项目目录结构及介绍

Typst-Fletcher 是一个开源项目，旨在通过 Typst 语言构建带有箭头的图表。项目目录结构如下：

• src/: 源代码目录，包含项目的主要 Typst 代码文件。
• docs/: 文档目录，存放项目的文档文件。
• tests/: 测试目录，包含对项目功能的测试代码。
• scripts/: 脚本目录，可能包含一些辅助脚本。
• .github/: GitHub 相关的配置文件目录。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。
• README.src.md: 源代码的 README 文件。
• package-excludes: 包排除文件，用于指定打包时排除的文件。
• pixi.lock: Pixi.js 的锁定文件，用于确保使用特定版本的依赖。
• pixi.toml: Pixi.js 的配置文件。
• typst.toml: Typst 的配置文件。

2. 项目的启动文件介绍

项目的启动文件通常是 src/ 目录中的 .typ 文件，这些文件包含了使用 Typst 语言编写的图表定义。例如，一个基础的启动文件可能看起来像这样：

import "fletcher" as fletcher

diagram(
    node("Start"),
    edge("Start", "End"),
    node("End")
)

在这个示例中，我们导入了 fletcher 包，并创建了一个包含两个节点和一条边的简单图表。

3. 项目的配置文件介绍

项目的配置文件主要包括 typst.toml 和 pixi.toml。

• typst.toml: 此文件用于配置 Typst 编译器和运行时的行为。例如，可以设置图表的默认大小、颜色主题等。

[build]
target = "web"

[diagrams]
default_size = "800x600"

在上述配置中，我们指定了构建目标为网页，并设置了图表的默认大小。

• pixi.toml: 此文件用于配置 Pixi.js 渲染器的行为，例如渲染分辨率等。

[renderer]
resolution = 1.0

在这个配置中，我们设置了渲染器的分辨率。

通过正确配置这些文件，用户可以定制化 Typst-Fletcher 的行为，以满足不同的项目需求。

typst-fletcher Typst package for drawing diagrams with arrows, built on top of CeTZ. 项目地址: https://gitcode.com/gh_mirrors/ty/typst-fletcher