File tree Expand file tree Collapse file tree 1 file changed +8
-18
lines changed Expand file tree Collapse file tree 1 file changed +8
-18
lines changed Original file line number Diff line number Diff line change @@ -29,34 +29,24 @@ Building the Nomicon requires [mdBook]. To get it:
29
29
$ cargo install mdbook
30
30
```
31
31
32
- ### Building
32
+ ### ` mdbook ` usage
33
33
34
- To build the Nomicon:
34
+ To build the Nomicon use the ` build ` sub-command :
35
35
36
36
``` bash
37
37
$ mdbook build
38
38
```
39
39
40
- The output will be in the ` book ` subdirectory. To check it out, open it in
41
- your web browser.
40
+ The output will be placed in the ` book ` subdirectory. To check it out, open the
41
+ ` index.html ` file in your web browser. You can pass the ` --open ` flag to `mdbook
42
+ build` and it'll open the index page (if the process is successful) just like with
43
+ ` cargo doc --open ` :
42
44
43
- _ Firefox:_
44
45
``` bash
45
- $ firefox book/index.html # Linux
46
- $ open -a " Firefox" book/index.html # OS X
47
- $ Start-Process " firefox.exe" .\b ook\i ndex.html # Windows (PowerShell)
48
- $ start firefox.exe .\b ook\i ndex.html # Windows (Cmd)
46
+ $ mdbook build --open
49
47
```
50
48
51
- _ Chrome:_
52
- ``` bash
53
- $ google-chrome book/index.html # Linux
54
- $ open -a " Google Chrome" book/index.html # OS X
55
- $ Start-Process " chrome.exe" .\b ook\i ndex.html # Windows (PowerShell)
56
- $ start chrome.exe .\b ook\i ndex.html # Windows (Cmd)
57
- ```
58
-
59
- To run the tests:
49
+ There is also a ` test ` sub-command to test all code samples contained in the book:
60
50
61
51
``` bash
62
52
$ mdbook test
You can’t perform that action at this time.
0 commit comments