hhshaohao 的个人博客
hhshaohao 的个人博客
Backlinks
Backlinks
迁移到 Typsite 0.1.8 [migrate-to-018]
迁移到 Typsite 0.1.8 [migrate-to-018]
Typsite 0.1.8 更换了构建引擎,修复了增量构建残留旧输出的问题,并支持 Typst 最新稳定版。已有的合法文章、模板、配置项和命令行选项继续受支持。本文说明从 0.1.7 升级时需要检查的变化。
从更早版本升级时,请先阅读 迁移到 Typsite 0.1.7 。
1 升级清单
备份文章、
root/libroot/lib和.typsite.typsite,尤其是自己修改过的模板和辅助函数。安装 Typsite 0.1.8 和 Typst 最新稳定版。本次已测试 Typst 0.15.1,不保证兼容旧版 Typst。
在另一个目录生成参考项目,不要在现有站点上直接初始化:
typsite init --dir ../typsite-018-referencetypsite init --dir ../typsite-018-reference对照参考项目的
root/libroot/lib和.typsite.typsite合并更新,保留自己的定制。执行平常使用的编译命令。旧内部缓存会自动按缓存未命中处理,通常不需要先手动清理。
typsite --version typst --version typsite compiletypsite --version typst --version typsite compile部署前同时检查生成的页面和命令退出状态。构建失败现在会返回非零退出码。
2 站点库与 Typst
2.1 更新 inline-math
请合并参考项目中的
root/lib/site.typ
root/lib/site.typ
。
inline-math
inline-math
现在在上下文中求值,查询脚注标签并传给 SVG 渲染器,支持行内和块级公式回退:
#inline-math($a/b$)
#inline-math($sum_(i=1)^n i$, block: true)
#inline-math($a/b$)
#inline-math($sum_(i=1)^n i$, block: true)
已有调用不需要修改函数签名。Typsite 会自动向 Typst 传入 HTML 功能标志和
html-frames
html-frames
输入参数。
2.2 不要修改内置包的版本号
Typsite 可执行程序的版本是 0.1.8,内置 Typst 包继续使用原来的标识:
#import "@local/typsite:0.1.0": *
#import "@local/typsite:0.1.0": *
不要把导入改为
@local/typsite:0.1.8
@local/typsite:0.1.8
。需要导出时,可执行程序会先安装随附的包。
2.3 编译内置演示站点
初始化的演示站点包含本文、模板、字体和 SVG 示例,构建时不需要下载 preview 包。在参考项目目录中运行:
typsite compile
typsite compile --port 8080
typsite compile
typsite compile --port 8080
第二条命令启动预览,可访问
http://localhost:8080/
http://localhost:8080/
或
/en/
/en/
。内容示例中的外部音乐播放器和网页字体仍需要浏览器联网,但不是构建依赖。
3 缓存与输出归属
新缓存保存 Typst 原始 HTML,以及 Typst 实际读取文件的指纹。导入或引用的文件变化时,会重新导出相应文章。旧缓存中的关系图和渲染片段不再恢复。
需要更新输出时,Typsite 会重新建立当前关系图,并重新组合所有页面,但只写入字节发生变化的文件。删除引用后,对应的旧反向链接会消失;删除或重命名文章后,旧的受管理输出也会移除。
输出目录中新增独立的归属记录:
publish/.typsite-outputs.json
publish/.typsite-outputs.json
请保留这个文件。 它不是可随意丢弃的缓存。Typsite 据此删除过期生成文件,同时保留无关文件。如果记录损坏,构建会拒绝猜测哪些文件可以删除;修复前请先备份。手动删除它,意味着放弃对之前输出文件的归属记录。
升级前生成、尚未被记录的文件不会被自动接管或删除。如果已经删除的旧页面仍留在输出目录中,请手动移除已确认过期的文件,或检查输出目录内容后显式执行清理。
3.1 更安全的 clean
typsite clean
typsite clean
会在删除前检查两个目标目录、取得构建锁,并拒绝清理与源文件或配置重叠的路径。没有归属标记的非空旧目录,需要明确允许:
# 先检查这两个目录;clean 会清空它们的内容。
typsite clean --cache ./.cache --output ./publish --force
# 先检查这两个目录;clean 会清空它们的内容。
typsite clean --cache ./.cache --output ./publish --force
源文件或配置目录不是默认位置时,也要传入,以便保护这些目录:
typsite clean --input ./content --config ./config \
--cache ./build-cache --output ./public --force
typsite clean --input ./content --config ./config \
--cache ./build-cache --output ./public --force
--force
--force
只允许清理没有标记的旧目录,不会绕过路径安全检查或正在使用的构建锁。清理后可能保留锁文件;构建或预览运行时,不要删除
.typsite.lock
.typsite.lock
。
4 更严格的校验
过去被忽略的错误,现在可能导致构建失败。请修复或移除无效资源,不要再依赖静默跳过:
- 页面模板、组件和重写器 HTML 必须包含完整的
<head>...</head><head>...</head>与<body>...</body><body>...</body>。有意留空时,可使用<head/><head/>或<body/><body/>。 - 损坏的主题、语法定义、语法元数据和重写器,即使没有用到,也会报错;重复的资源标识会被拒绝。
- 页面不能显式把自己设为父页面,也不能嵌入自己。父级继承、嵌入或元数据依赖形成循环时会报错,不再挂起;普通的相互引用和自引用仍然合法。
- 源文件、配置、缓存和输出目录不能相互重叠;本地包源也不能与缓存或输出目录重叠。输出冲突、仅大小写不同的路径冲突、越界路径和受管理输出中的符号链接会被拒绝。目录名中的空格和方括号按字面处理。
-
.typsite.lock.typsite.lock与.typsite-outputs.json.typsite-outputs.json是保留的输出名称,包括大小写变体,以及这些名称之下的路径。
5 包目录与可复现构建
--packages
--packages
仍指向本地包的源文件目录,不是 Typst 包命名空间。安装前会拒绝无效的包名、版本和重复标识。
需要隔离时,可设置
TYPST_PACKAGE_PATH
TYPST_PACKAGE_PATH
,包会安装到它下面的
local/<name>/<version>
local/<name>/<version>
。Typsite 同时支持
TYPST_PACKAGE_CACHE_PATH
TYPST_PACKAGE_CACHE_PATH
。例如在 POSIX shell 中:
export TYPST_PACKAGE_PATH="$PWD/.typst-packages"
export TYPST_PACKAGE_CACHE_PATH="$PWD/.typst-package-cache"
typsite compile
export TYPST_PACKAGE_PATH="$PWD/.typst-packages"
export TYPST_PACKAGE_CACHE_PATH="$PWD/.typst-package-cache"
typsite compile
这些目录应与源文件、配置、构建缓存和输出目录分开。没有指定路径时,仍保留默认的共享包安装行为。需要可复现导出时,请使用项目字体和固定的
SOURCE_DATE_EPOCH
SOURCE_DATE_EPOCH
;系统字体或未声明的外部输入发生变化后,可能需要丢弃构建缓存。
6 并行构建与 –jobs
独立文件指纹、文章解析和页面渲染现在使用 Rayon。Typst 并发导出默认以可用 CPU/Rayon 预算为上限(不再固定限制为四篇),每个子进程再分得部分 CPU 工作线程。内存受限时,可用
typsite compile --jobs 1
typsite compile --jobs 1
串行导出文章;也可用
--jobs 4
--jobs 4
明确限制并发数(别名
-j
-j
,参数必须是正整数)。
--jobs
--jobs
不控制全部 Rayon 工作;文件指纹、解析与渲染可通过
RAYON_NUM_THREADS
RAYON_NUM_THREADS
调整。包在工作线程启动前统一准备,结果按稳定的源文件顺序汇总,全部线程结束后才记录检查点或发布。关系与元数据顺序、过期删除和发布归属仍受保护。独立输出并行原子替换并同步数据。可丢弃的缓存现在使用带校验和、共享依赖集的二进制清单和按内容指纹索引的高亮资源缓存,旧格式会自动重建。已验证的无变化构建仍检查输入、导出产物和输出的内容哈希,但不再重解析所有配置。已安装本地包在导出前计算指纹,避免不必要的验证导出;新发现的外部输入仍需验证。只改变并发数无需清缓存,生成的输出字节相同。
7 RSS 订阅配置
RSS 2.0 支持摘要或全文。配置分为两个步骤:先在站点配置中开启文件生成,再通过集合页选择文章。文章元数据
rss
rss
默认是 false;只填写站点地址不会自动选出任何条目。
7.1 第一步:配置站点
修改
.typsite/options.toml
.typsite/options.toml
已有的
[site]
[site]
,不要重复添加同名配置段。把示例地址换成站点部署后的公开地址:
[site]
base_url = "https://example.org"
title = "我的站点"
description = "笔记与文章"
rss_path = "/rss.xml"
rss_limit = 20
rss_content = "summary" # 可选 "summary" 或 "full"
sitemap_path = "/sitemap.xml"
[site]
base_url = "https://example.org"
title = "我的站点"
description = "笔记与文章"
rss_path = "/rss.xml"
rss_limit = 20
rss_content = "summary" # 可选 "summary" 或 "full"
sitemap_path = "/sitemap.xml"
保留
[default_metadata.options]
[default_metadata.options]
下的
rss = false
rss = false
,也可以省略。这是每篇文章的默认值,不是
[site]
[site]
下的开关。请在具体集合页中显式开启,不要把所有文章的默认值都改为 true。
7.2 第二步:标记集合页并嵌入条目
合并新版
root/lib/lib.typ
root/lib/lib.typ
的
rss
rss
导入,或像下面一样直接从内置包导入。例如创建
root/feed.typ
root/feed.typ
,嵌入演示站点中已有的两篇文章:
#import "/lib/lib.typ": *
#import "@local/typsite:0.1.0": rss
#show: schema.with("page")
#title[订阅集合]
#rss(true)
= #embed("./typst.typ")
= #embed("./article.typ")
#import "/lib/lib.typ": *
#import "@local/typsite:0.1.0": rss
#show: schema.with("page")
#title[订阅集合]
#rss(true)
= #embed("./typst.typ")
= #embed("./article.typ")
这会选出
typst.typ
typst.typ
和
article.typ
article.typ
,不包含
feed.typ
feed.typ
。自己的站点应替换为实际文章路径。只选择直接嵌入;嵌套嵌入、引用、父级关系和仅声明的 child 图关系不添加条目。多个集合的选择合并去重。标记页自身始终排除,即使被另一个集合嵌入也不例外;标记不会被子文章继承。
#rss(false)
#rss(false)
只取消集合标记,不会排除被其他集合选中的文章。
7.3 第三步:构建与订阅
typsite compile
typsite compile --port 8080
typsite compile
typsite compile --port 8080
第一条命令生成
publish/rss.xml
publish/rss.xml
,使用自定义输出目录或路径时则写到相应位置。第二条命令可通过
http://localhost:8080/rss.xml
http://localhost:8080/rss.xml
本地检查。读者应订阅部署后的公开地址,例如
https://example.org/rss.xml
https://example.org/rss.xml
,而不是 localhost 预览地址。每个生成页面的 HTML head 中也会加入 RSS 自动发现链接。
演示站点的两个首页已有
#rss(true)
#rss(true)
。填写
base_url
base_url
后,它们直接嵌入的文章会组成四个条目:中英文文章指南和 Typst 简介。再加入上面的
feed.typ
feed.typ
只会重复选中已有文章,不会生成重复条目。首页、迁移指南和内容示例不会自动进入 RSS;站点地图仍包含所有编译文章。
7.4 内容模式与常见配置问题
-
rss_content = "summary"rss_content = "summary"是默认模式:依次取非空的descriptiondescription、summarysummary、abstractabstract元数据。可在所选文章里写#metacontent("summary")[简短介绍。]#metacontent("summary")[简短介绍。];缺少摘要不会排除文章。 -
rss_content = "full"rss_content = "full"还会输出组合后的文章 HTML,不含页面导航、侧边栏或引用与反向链接页脚。嵌入内容仍保留在所选文章内部。不同阅读器对 SVG、MathML 和站点专用 CSS 的支持不同。 - 没有生成
rss.xmlrss.xml:检查base_urlbase_url、rss_pathrss_path是否非空,以及rss_limitrss_limit是否大于零。默认路径和上限仍是/rss.xml/rss.xml、20。非空但无效的站点 URL 会导致校验失败。 - 文件有了但没有条目:检查集合页是否写了
#rss(true)#rss(true),以及是否有实际的直接#embed(...)#embed(...)。只填写[site].base_url[site].base_url不够;rss = falserss = false也不是条目排除开关。 - RSS 日期使用 RFC 2822,不使用 ISO 时间戳。纯日期和
YYYY-MM-DD HH:MM[:SS]YYYY-MM-DD HH:MM[:SS]按 UTC 处理;RFC 3339/RFC 2822 的偏移会转换为 UTC。无效日期省略,标题和摘要提取为文本,不会直接显示 HTML 标签。
更多选项与文章元数据示例见 首页的 RSS 章节 。
8 预览与失败恢复
仍通过非零的
--port
--port
启动预览。所有已连接客户端会观察到同一构建版本;真正没有变化的轮询不会刷新浏览器。导出、解析或渲染失败时保留上次成功发布的页面,修复成功后触发刷新。按 Ctrl-C 会等待正在执行的构建结束,再退出。
即使后续发布失败,已经成功导出的结果也能复用。修复报错后,重新运行相同命令即可。发布只保证单个文件的原子替换,不是整个站点的事务:发布中途失败可能留下完整的新旧文件混合状态,普通重试会修复。如果部署要求站点整体切换,请另设部署步骤。