You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: website/typst-docs-web/README.md
+5-2Lines changed: 5 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@
4
4
<imgsrc="./images/preview.png"alt="">
5
5
</div>
6
6
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).
8
8
9
9
## Required toolchains
10
10
@@ -23,6 +23,9 @@ bun = "1.2.21"
23
23
24
24
## Setup
25
25
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
+
26
29
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.
27
30
28
31
```sh
@@ -40,7 +43,7 @@ Create `/public/metadata.json` and describe the metadata for the documentation w
0 commit comments