Skip to content

Commit 4711485

Browse files
committed
Document the SPEC_RELATIVE option
1 parent 1a52c1f commit 4711485

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -61,13 +61,15 @@ To build the Reference locally (in `build/`) and open it in a web
6161
browser, run:
6262

6363
```sh
64-
mdbook build --open
64+
SPEC_RELATIVE=0 mdbook build --open
6565
```
6666

6767
This will open a browser with a websocket live-link to automatically reload whenever the source is updated.
6868

69-
You can also open any current build of the reference by running:
69+
The `SPEC_RELATIVE=0` environment variable makes links to the standard library go to <https://doc.rust-lang.org/> instead of being relative, which is useful when viewing locally since you normally don't have a copy of the standard library.
70+
71+
You can also use mdbook's live webserver option, which will automatically rebuild the book and reload your web browser whenever a source file is modified:
7072

7173
```sh
72-
mdbook serve --open
74+
SPEC_RELATIVE=0 mdbook serve --open
7375
```

0 commit comments

Comments
 (0)