Skip to content

Commit bd6f27b

Browse files
committed
docs: apply suggestions
1 parent 59ed486 commit bd6f27b

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

website/typst-docs-web/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<img src="./images/preview.png" alt="">
55
</div>
66

7-
A generator that builds a website from a documentation JSON file generated by typst-docs.
7+
Build a website from the documentation JSON file generated by [typst-docs](https://github.com/typst/typst/blob/main/docs/Cargo.toml#L2).
88

99
## Required toolchains
1010

@@ -23,6 +23,9 @@ bun = "1.2.21"
2323

2424
## Setup
2525

26+
> [!NOTE]
27+
> 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 [v0.13.1](https://github.com/typst/typst/tree/v0.13.1). Other versions are usually compatible as well, but they have not been tested carefully.
28+
2629
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.
2730

2831
```sh
@@ -40,7 +43,7 @@ Create `/public/metadata.json` and describe the metadata for the documentation w
4043

4144
```json
4245
{
43-
"$schema": "/path/to/typst-docs-web/metadata.schema.json",
46+
"$schema": "../metadata.schema.json",
4447
"language": "ja-JP",
4548
"version": "0.13.1",
4649
"typstOfficialUrl": "https://typst.app",

0 commit comments

Comments
 (0)