Skip to content

Commit 0a0a968

Browse files
committed
Merge branch 'master' of https://github.com/azerupi/mdBook
2 parents 2d00f40 + 6c94ba8 commit 0a0a968

File tree

7 files changed

+18
-8
lines changed

7 files changed

+18
-8
lines changed

book-example/src/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
- [init](cli/init.md)
66
- [build](cli/build.md)
77
- [watch](cli/watch.md)
8+
- [test](cli/test.md)
89
- [Format](format/format.md)
910
- [SUMMARY.md](format/summary.md)
1011
- [Configuration](format/config.md)

book-example/src/cli/build.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
The build command is used to render your book:
44

5-
```
5+
```bash
66
mdbook build
77
```
88

@@ -17,7 +17,7 @@ convenience. Large books will therefore remain structured when rendered.
1717
Like `init`, the `build` command can take a directory as argument to use instead of the
1818
current working directory.
1919

20-
```
20+
```bash
2121
mdbook build path/to/book
2222
```
2323

book-example/src/cli/cli-tool.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ If you haven't already, you should begin by installing [Rust](https://www.rust-l
1212

1313
Open your terminal and navigate to the directory of you choice. We need to clone the git repository and then build it with Cargo.
1414

15-
```
15+
```bash
1616
git clone --depth=1 https://github.com/azerupi/mdBook.git
1717
cd mdBook
1818
cargo build --release

book-example/src/cli/init.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
The `init` command is used like this:
44

5-
```
5+
```bash
66
mdbook init
77
```
88

@@ -11,7 +11,7 @@ spend more time writing your book and less setting it up.
1111

1212
The files set up for you are the following:
1313

14-
```
14+
```text
1515
book-test/
1616
├── book
1717
└── src
@@ -34,7 +34,7 @@ When a `SUMMARY.md` file already exists, the `init` command will generate the fi
3434
When using the `init` command, you can also specify a directory, instead of using the current working directory,
3535
by appending a path to the command:
3636

37-
```
37+
```bash
3838
mdbook init path/to/book
3939
```
4040

book-example/src/cli/test.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# The test command
2+
3+
It’s nice to be able to ensure that examples in documentation are current.
4+
mdBook supports a ‘test’ command, which will use Rustdoc to test out examples:
5+
6+
```bash
7+
$ mdbook test
8+
[*]: Testing file: "/mdBook/book-example/src/README.md”
9+
```

book-example/src/cli/watch.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@ You could issue `mdbook build` everytime you change a file. But using `mdbook wa
88
Like `init` and `build`, `watch` can take a directory as argument to use instead of the
99
current working directory.
1010

11-
```
11+
```bash
1212
mdbook watch path/to/book
1313
```

book-example/src/lib/lib.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
mdBook is not only a command line tool, it can be used as a crate. You can extend it,
44
integrate it in current projects. Here is a short example:
55

6-
```rust
6+
```rust,ignore
77
extern crate mdbook;
88
99
use mdbook::MDBook;

0 commit comments

Comments
 (0)