Skip to content

ci: add the last JSON-based docs and update README #58

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
3w36zj6 merged 1 commit into from
May 9, 2026
Merged

ci: add the last JSON-based docs and update README #58

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/ci.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ jobs:
matrix:
kind: [official]
tag:
- main.2026-05-05.0d72726
- v0.14.2
- v0.14.1
- v0.14.0
Expand Down
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<img src="./images/preview.png" alt="">
</div>

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

Expand All @@ -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.

@YDX-2147483647 YDX-2147483647 May 6, 2026 •
edited
Loading

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other versions of the JSON structure are usually compatible

This is exactly what I mean.
The current typst-docs-web is compatible with most (if not all) versions of typst-docs that output JSON, but not other versions.

>
> 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.

Expand Down
Loading