Skip to content

Commit 9fe19d8

Browse files
Increase Documentation Coverage (#543)
* Added documentation to the `config` module * Added an example to the `config` module * Updated the docs in lib.rs regarding implementing backends * Started writing an alternate backends walkthrough * Mentioned the output.foo.command key * Added example output * Added a config section to the backends tutorial * Finished off the backends tutorial * Made sure travis checks mdbook-wordcount * Fixed the broken link at in the user guide * Changed how travis builds the project * Added a conclusion * Went through and documented a lot of stuff * Added a preprocessors chapter and updated For Developers
1 parent 232a923 commit 9fe19d8

File tree

19 files changed

+625
-241
lines changed

19 files changed

+625
-241
lines changed

Cargo.toml

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,19 +20,19 @@ chrono = "0.4"
2020
handlebars = "0.29"
2121
serde = "1.0"
2222
serde_derive = "1.0"
23-
error-chain = "0.11.0"
23+
error-chain = "0.11"
2424
serde_json = "1.0"
2525
pulldown-cmark = "0.1"
2626
lazy_static = "1.0"
2727
log = "0.4"
2828
env_logger = "0.5.0-rc.1"
2929
toml = "0.4"
30-
memchr = "2.0.1"
30+
memchr = "2.0"
3131
open = "1.1"
3232
regex = "0.2.1"
3333
tempdir = "0.3.4"
34-
itertools = "0.7.4"
35-
shlex = "0.1.1"
34+
itertools = "0.7"
35+
shlex = "0.1"
3636
toml-query = "0.6"
3737

3838
# Watch feature
@@ -66,3 +66,5 @@ doc = false
6666
name = "mdbook"
6767
path = "src/bin/mdbook.rs"
6868

69+
[workspace]
70+
members = ["book-example/src/for_developers/mdbook-wordcount"]

book-example/book.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[book]
22
title = "mdBook Documentation"
33
description = "Create book from markdown files. Like Gitbook but implemented in Rust"
4-
author = "Mathieu David"
4+
authors = ["Mathieu David", "Michael-F-Bryan"]
55

66
[output.html]
77
mathjax-support = true

book-example/src/SUMMARY.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@
1616
- [Editor](format/theme/editor.md)
1717
- [MathJax Support](format/mathjax.md)
1818
- [Rust code specific features](format/rust.md)
19-
- [For Developers](lib/index.md)
19+
- [For Developers](for_developers/index.md)
20+
- [Preprocessors](for_developers/preprocessors.md)
21+
- [Alternate Backends](for_developers/backends.md)
2022
-----------
2123
[Contributors](misc/contributors.md)

0 commit comments

Comments
 (0)