docs: clarify how to use this project

Relates-to: #4

Author: YDX-2147483647

CONTRIBUTING.md

@@ -2,7 +2,11 @@
 
 ## Local preview
 
-First install [mdbook](https://rust-lang.github.io/mdBook/guide/installation.html), [uv](https://docs.astral.sh/uv/#installation), [just](https://just.systems/man/en/), and rust toolchains, then run:
+1. Install [mdbook](https://rust-lang.github.io/mdBook/guide/installation.html), [uv](https://docs.astral.sh/uv/#installation), [just](https://just.systems/man/en/), and the [rust toolchain](https://rustup.rs).
+
+2. Clone this repository and change to the directory.
+
+3. Run the following commands.
 
 ```shell
 cargo install --git https://github.com/sitandr/mdbook-typst-highlight --branch main # d7c197c6, the unreleased version

README.md

@@ -1,14 +1,20 @@
 # Typst Extra Docs
 
 [![GitHub repo size](https://img.shields.io/github/repo-size/typst-community/extra-docs)](https://github.com/typst-community/extra-docs)
-[![Website](https://img.shields.io/website?url=https%3A%2F%2Ftypst-community.github.io%2Fextra-docs%2F)](https://typst-community.github.io/extra-docs/)
+[![Website](https://img.shields.io/website?url=https%3A%2F%2Ftypst-community.github.io%2Fextra-docs%2F)][homepage]
+
+[homepage]: https://typst-community.github.io/extra-docs/
 
 This is an _unofficial_ collection of extra official documentations for Typst.
 
 - [Typst's official GitHub repositories (github.com/typst)](https://github.com/orgs/typst/repositories?type=source&q=mirror%3Afalse+fork%3Afalse+archived%3Afalse) contain some files that are missing in the official [Typst Documentation (typst.app/docs)](https://typst.app/docs/). These files are collected here to help with reading and searching.
 
+  To view these files, visit the [Typst Extra Docs website][homepage].<!-- NOTE: This line will be parsed by download.py. -->
+
 - [Snapshots of the official Typst Documentation](./src/zim/index.md) are also stored here, for reading offline or using previous versions.
 
+  To download and use them, refer to the page [Snapshots of Docs](./src/zim/index.md).
+
 ## See also
 
 - [hypher — Docs.rs](https://docs.rs/crate/hypher/latest) lists the languages supported by Typst for hyphenation.

scripts/download.py

@@ -159,7 +159,13 @@ def load_versions() -> dict[Literal["typst", "codex", "hayagriva", "packages"],
     versions = load_versions()
 
     (src_dir / "index.md").write_text(
-        (src_dir.parent / "README.md").read_text(encoding="utf-8").replace("](./src/", "](./"),
+        (src_dir.parent / "README.md")
+        .read_text(encoding="utf-8")
+        .replace("](./src/", "](./")
+        .replace(
+            "visit the [Typst Extra Docs website][homepage].<!-- NOTE: This line will be parsed by download.py. -->",
+            "continue browsing this website.",
+        ),
         encoding="utf-8",
     )