Skip to content

Increase Documentation Coverage #543

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 14 commits into from
Jan 21, 2018
Merged

Increase Documentation Coverage #543

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
15d6672
Added documentation to the `config` module
Michael-F-Bryan Jan 14, 2018
10ba2fc
Added an example to the `config` module
Michael-F-Bryan Jan 14, 2018
8b874c5
Updated the docs in lib.rs regarding implementing backends
Michael-F-Bryan Jan 15, 2018
ac427b1
Started writing an alternate backends walkthrough
Michael-F-Bryan Jan 15, 2018
fc3de91
Mentioned the output.foo.command key
Michael-F-Bryan Jan 15, 2018
332b639
Added example output
Michael-F-Bryan Jan 15, 2018
8f18c69
Added a config section to the backends tutorial
Michael-F-Bryan Jan 16, 2018
2342d06
Finished off the backends tutorial
Michael-F-Bryan Jan 16, 2018
60380d3
Made sure travis checks mdbook-wordcount
Michael-F-Bryan Jan 16, 2018
9b24f64
Fixed the broken link at in the user guide
Michael-F-Bryan Jan 16, 2018
0574eb0
Changed how travis builds the project
Michael-F-Bryan Jan 17, 2018
96df358
Added a conclusion
Michael-F-Bryan Jan 19, 2018
e1262de
Went through and documented a lot of stuff
Michael-F-Bryan Jan 21, 2018
c0f3b5c
Added a preprocessors chapter and updated For Developers
Michael-F-Bryan Jan 21, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,19 +20,19 @@ chrono = "0.4"
handlebars = "0.29"
serde = "1.0"
serde_derive = "1.0"
error-chain = "0.11.0"
error-chain = "0.11"
serde_json = "1.0"
pulldown-cmark = "0.1"
lazy_static = "1.0"
log = "0.4"
env_logger = "0.5.0-rc.1"
toml = "0.4"
memchr = "2.0.1"
memchr = "2.0"
open = "1.1"
regex = "0.2.1"
tempdir = "0.3.4"
itertools = "0.7.4"
shlex = "0.1.1"
itertools = "0.7"
shlex = "0.1"
toml-query = "0.6"

# Watch feature
Expand Down Expand Up @@ -66,3 +66,5 @@ doc = false
name = "mdbook"
path = "src/bin/mdbook.rs"

[workspace]
members = ["book-example/src/for_developers/mdbook-wordcount"]
2 changes: 1 addition & 1 deletion book-example/book.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[book]
title = "mdBook Documentation"
description = "Create book from markdown files. Like Gitbook but implemented in Rust"
author = "Mathieu David"
authors = ["Mathieu David", "Michael-F-Bryan"]

[output.html]
mathjax-support = true
Expand Down
4 changes: 3 additions & 1 deletion book-example/src/SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
- [Editor](format/theme/editor.md)
- [MathJax Support](format/mathjax.md)
- [Rust code specific features](format/rust.md)
- [For Developers](lib/index.md)
- [For Developers](for_developers/index.md)
- [Preprocessors](for_developers/preprocessors.md)
- [Alternate Backends](for_developers/backends.md)
-----------
[Contributors](misc/contributors.md)
Loading