diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index ea0c779..ce83d99 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -64,6 +64,7 @@ jobs: matrix: kind: [official] tag: + - main.2026-05-05.0d72726 - v0.14.2 - v0.14.1 - v0.14.0 diff --git a/README.md b/README.md index 200218b..a68b857 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ -Build a website from the documentation JSON file generated by [typst-docs](https://github.com/typst/typst/blob/main/docs/Cargo.toml#L2). +Build a website from the documentation JSON file generated by [typst-docs](https://github.com/typst/typst/blob/0d727267164629c6124bd2af1f334c1c7edc9f98/docs/Cargo.toml#L2). ## Required toolchains @@ -24,7 +24,9 @@ bun = "1.2.21" ## Setup > [!NOTE] -> The JSON structure generated by typst-docs is not stable and may change at any time. This project is confirmed to be compatible with typst-docs from [v0.13.1](https://github.com/typst/typst/tree/v0.13.1) to [v0.14.2](https://github.com/typst/typst/releases/tag/v0.14.2). Other versions are usually compatible as well, but they have not been tested carefully. +> The JSON structure generated by typst-docs was an unstable representation of the Typst documentation. This project is confirmed to be compatible with typst-docs from [v0.13.1](https://github.com/typst/typst/tree/v0.13.1) to [v0.14.2](https://github.com/typst/typst/releases/tag/v0.14.2). Other versions of the JSON structure are usually compatible as well, but they have not been tested carefully. +> +> Note that [typst/typst#8138](https://github.com/typst/typst/pull/8138) (merged on 2026-05-05) deleted the JSON-based infrastructure and migrated to Typst. The typst-docs CLI outputs the static files required for building the documentation. Place the JSON file and assets generated by typst-docs in the `/public/` directory. In most use cases, symbolic links are convenient.