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
[`mdbook-spec`](https://github.com/rust-lang/reference/tree/master/mdbook-spec) is an mdBook preprocessor that adds features to the Reference. It provides:
4
+
5
+
- Parsing and generation of [grammar diagrams](../grammar.md).
6
+
-[Automatic grammar production links](../grammar.md#automatic-linking).
7
+
- Generation of the [grammar summary appendix](https://doc.rust-lang.org/nightly/reference/grammar.html).
8
+
-[Automatic standard library links](../links.md#standard-library-links).
9
+
- Handling of [rule names](../rules.md).
10
+
- Validation of the names.
11
+
- Converting rule names to links.
12
+
-[Automatic rule link references](../links.md#rule-links).
13
+
- Generation of [links to rule tests](../rules/test-annotations.md).
14
+
- Generation of the [test summary](https://doc.rust-lang.org/nightly/reference/test-summary.html).
15
+
- Support for [admonitions](../formatting/admonitions.md).
16
+
17
+
## Environment variables
18
+
19
+
There are a few environment variables that `mdbook-spec` uses, described in the [Building chapter](building.md):
20
+
21
+
-[`SPEC_RELATIVE`](building.md#SPEC_RELATIVE) --- Can be set to link external books to the live site.
22
+
-[`SPEC_DENY_WARNINGS`](building.md#SPEC_DENY_WARNINGS) --- Whether warnings should be treated as errors.
23
+
-[`SPEC_RUST_ROOT`](building.md#SPEC_RUST_ROOT) --- The path to a checkout of the [`rust-lang/rust`](https://github.com/rust-lang/rust) GitHub repository. This is used for test linking.
0 commit comments