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
These validations can cause errors during local builds (see Link Validations section below). Please **do not** commit these `book.toml` file changes when you submit a pull request.
64
+
65
+
To build a local static HTML site, install [`mdbook`](https://github.com/rust-lang/mdBook) with:
66
+
67
+
```
68
+
> cargo install mdbook
69
+
```
70
+
71
+
and execute the following command in the root of the repository:
72
+
73
+
```
74
+
> mdbook build
75
+
```
76
+
77
+
The build files are found in the `book` directory.
78
+
79
+
### Link Validations
80
+
81
+
We use `mdbook-linkcheck` to validate URLs included in our documentation. To perform link checks, uncomment the `[output.linkcheck]` field in the `book.toml` configuration file and install `mdbook-linkcheck` with:
40
82
41
83
```bash
42
84
> cargo install mdbook-linkcheck
43
85
```
44
86
45
-
You will need `mdbook` version `>= 0.3.5` and `mdbook-linkcheck` version `>= 0.5`.
46
-
`linkcheck` will be run automatically when you run `mdbook build`.
87
+
You will need `mdbook` version `>= 0.3.5` and `mdbook-linkcheck` version `>= 0.5` to check links.
88
+
`linkcheck` will be run automatically when you build with the instructions in the section above.
89
+
90
+
**Please note**: You may receive errors like the following when link checks are active on local `mdbook` builds:
91
+
92
+
```
93
+
error: The server responded with 429 Too Many Requests for "https://github.com/rust-lang/rust/tree/master/src/tools/compiletest"
94
+
95
+
┌── tests/intro.md:6:1 ───
96
+
│
97
+
6 │ [`src/tools/compiletest`] directory). This section gives a brief
98
+
│ ^ Server responded with 429 Too Many Requests
99
+
```
100
+
101
+
There is not a workaround for this error at the moment. Comment out the `[output.linkcheck]` field in the `book.toml` using the build instructions above to complete a local site build without link validations.
0 commit comments