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: README.md
+4-2Lines changed: 4 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ documentation useful for members of [The Rust Programming Language].
8
8
9
9
# Development
10
10
11
-
You can build a local version by running the following command.
11
+
You can build a local version by installing [mdbook] and running the following command.
12
12
13
13
```console
14
14
mdbook build
@@ -18,6 +18,8 @@ This will build and run the `blacksmith` tool automatically. When developing
18
18
it's recommended to use the `serve` command to launch a local server to allow
19
19
you to easily see and update changes you make.
20
20
21
+
[mdbook]: https://github.com/rust-lang/mdBook
22
+
21
23
```console
22
24
mdbook serve
23
25
```
@@ -59,7 +61,7 @@ Any Rust team can have a section in the Rust Forge. If you'd like to add your te
59
61
```
60
62
61
63
If you run `mdbook build`, `mdbook` will automatically create the folder and file for your team.
62
-
64
+
63
65
It's recommended that you put general team information in `src/<TEAM_NAME>/README.md`, such as where the meetings happen, repositories that the team manages, links to chat platforms, etc. Larger topics should be made as a subpage, e.g. (`src/release/topic.md`).
0 commit comments