mdBook/Cargo.toml

[package]
name = "mdbook"
version = "0.4.32"
authors = [
    "Mathieu David <mathieudavid@mathieudavid.org>",
    "Michael-F-Bryan <michaelfbryan@gmail.com>",
    "Matt Ickstadt <mattico8@gmail.com>"
]
documentation = "https://rust-lang.github.io/mdBook/index.html"
edition = "2021"
exclude = ["/guide/*"]
keywords = ["book", "gitbook", "rustbook", "markdown"]
license = "MPL-2.0"
readme = "README.md"
repository = "https://github.com/rust-lang/mdBook"
description = "Creates a book from markdown files"
rust-version = "1.66"

[dependencies]
anyhow = "1.0.71"
chrono = { version = "0.4.24", default-features = false, features = ["clock"] }
clap = { version = "4.3.12", features = ["cargo", "wrap_help"] }
clap_complete = "4.3.2"
once_cell = "1.17.1"
env_logger = "0.10.0"
handlebars = "4.3.7"
log = "0.4.17"
memchr = "2.5.0"
opener = "0.6.1"
pulldown-cmark = { version = "0.9.3", default-features = false }
regex = "1.8.1"
serde = { version = "1.0.163", features = ["derive"] }
serde_json = "1.0.96"
shlex = "1.1.0"
tempfile = "3.4.0"
toml = "0.7.6"
topological-sort = "0.2.2"

# Watch feature
notify = { version = "6.0.1", optional = true, features = ["macos_kqueue"] }
notify-debouncer-mini = { version = "0.3.0", optional = true }
ignore = { version = "0.4.20", optional = true }

# Serve feature
futures-util = { version = "0.3.28", optional = true }
tokio = { version = "1.28.1", features = ["macros", "rt-multi-thread"], optional = true }
warp = { version = "0.3.5", default-features = false, features = ["websocket"], optional = true }

# Search feature
elasticlunr-rs = { version = "3.0.2", optional = true }
ammonia = { version = "3.3.0", optional = true }

[dev-dependencies]
assert_cmd = "2.0.11"
predicates = "3.0.3"
select = "0.6.0"
semver = "1.0.17"
pretty_assertions = "1.3.0"
walkdir = "2.3.3"

[features]
default = ["watch", "serve", "search"]
watch = ["dep:notify", "dep:notify-debouncer-mini", "dep:ignore"]
serve = ["dep:futures-util", "dep:tokio", "dep:warp"]
search = ["dep:elasticlunr-rs", "dep:ammonia"]

[[bin]]
doc = false
name = "mdbook"

[[example]]
name = "nop-preprocessor"
test = true
Initial commit 2015-07-06 12:21:59 +00:00			`[package]`
			`name = "mdbook"`
Update to 0.4.32 2023-07-17 00:35:51 +00:00			`version = "0.4.32"`
Begin development for the 0.2.0 release 2018-08-02 18:31:58 +00:00			`authors = [`
Delete extra space 2018-12-25 12:10:45 +00:00			`"Mathieu David <mathieudavid@mathieudavid.org>",`
Begin development for the 0.2.0 release 2018-08-02 18:31:58 +00:00			`"Michael-F-Bryan <michaelfbryan@gmail.com>",`
			`"Matt Ickstadt <mattico8@gmail.com>"`
			`]`
Update docs link in Cargo.toml to HTTPS version Currently, the documentation link is specified in Cargo.toml as: documentation = "http://rust-lang.github.io/mdBook/index.html" which propagates to crates.io and if users click on the docs link there they get the non-TLS version. Not likely to cause major issues, but still best practice to use the HTTPS version since it's there 2022-11-19 01:53:08 +00:00			`documentation = "https://rust-lang.github.io/mdBook/index.html"`
Require Rust 2021 edition This allows us to clean up and simplify the code. 2022-06-24 11:20:02 +00:00			`edition = "2021"`
Rename `book-example` to `guide` (#1336) `book-example` is a bit of a strange name given that it's not just an example. 2020-09-23 01:16:09 +00:00			`exclude = ["/guide/*"]`
Added crate metadata 2015-08-06 21:37:44 +00:00			`keywords = ["book", "gitbook", "rustbook", "markdown"]`
Some clean-up + initial implementation of '--theme' flag for init. Still needs some work 2015-08-11 14:13:41 +00:00			`license = "MPL-2.0"`
Added crate metadata 2015-08-06 21:37:44 +00:00			`readme = "README.md"`
rust-lang-nursery -> rust-lang Fixes #1080 2019-10-29 13:04:16 +00:00			`repository = "https://github.com/rust-lang/mdBook"`
Transition to 2018 edition (#933) * Transition to 2018 edition * Update Travis CI badge in README * Remove non-idiomatic `extern crate` lines 2019-05-25 18:50:41 +00:00			`description = "Creates a book from markdown files"`
Update msrv to 1.66. 2023-07-16 20:21:45 +00:00			`rust-version = "1.66"`
Skeleton for main.rs (binary) 2015-07-06 19:12:24 +00:00
			`[dependencies]`
Set minimum versions in Cargo.toml 2023-05-13 19:01:03 +00:00			`anyhow = "1.0.71"`
			`chrono = { version = "0.4.24", default-features = false, features = ["clock"] }`
Update to clap 4.3.12 2023-07-16 19:33:53 +00:00			`clap = { version = "4.3.12", features = ["cargo", "wrap_help"] }`
			`clap_complete = "4.3.2"`
Set minimum versions in Cargo.toml 2023-05-13 19:01:03 +00:00			`once_cell = "1.17.1"`
Update env_logger Update env_logger from 0.9.3 to 0.10.0 https://github.com/rust-cli/env_logger/blob/main/CHANGELOG.md#0100---2022-11-24 2022-12-14 15:53:24 +00:00			`env_logger = "0.10.0"`
Set minimum versions in Cargo.toml 2023-05-13 19:01:03 +00:00			`handlebars = "4.3.7"`
			`log = "0.4.17"`
			`memchr = "2.5.0"`
Update opener to 0.6.1 2023-07-16 19:37:23 +00:00			`opener = "0.6.1"`
Update pulldown-cmark to 0.9.3 2023-05-28 19:00:00 +00:00			`pulldown-cmark = { version = "0.9.3", default-features = false }`
Set minimum versions in Cargo.toml 2023-05-13 19:01:03 +00:00			`regex = "1.8.1"`
			`serde = { version = "1.0.163", features = ["derive"] }`
			`serde_json = "1.0.96"`
			`shlex = "1.1.0"`
			`tempfile = "3.4.0"`
Update toml to 0.7.6 2023-07-16 19:48:01 +00:00			`toml = "0.7.6"`
Update topological-sort Update topological-sort from 0.1.0 to 0.2.2 https://github.com/gifnksm/topological-sort-rs/compare/v0.1.0...v0.2.2 2022-12-14 16:04:59 +00:00			`topological-sort = "0.2.2"`
Add debug! macro that can be activated using the "debug" feature. #19 2015-08-03 16:06:01 +00:00
Watch builds are now spawned in new threads (using crossbeam) and there is a timelock, preventing multiple builds being triggered in less than a second 2015-11-09 13:31:00 +00:00			`# Watch feature`
Switch macOS notify to kqueue. 2023-08-02 16:21:25 +00:00			`notify = { version = "6.0.1", optional = true, features = ["macos_kqueue"] }`
Update notify to 6.0.1 2023-07-16 19:40:45 +00:00			`notify-debouncer-mini = { version = "0.3.0", optional = true }`
Switch from gitignore to ignore 2023-04-22 19:49:39 +00:00			`ignore = { version = "0.4.20", optional = true }`
Watch builds are now spawned in new threads (using crossbeam) and there is a timelock, preventing multiple builds being triggered in less than a second 2015-11-09 13:31:00 +00:00
Implement Serve feature 2016-04-02 02:46:05 +00:00			`# Serve feature`
Set minimum versions in Cargo.toml 2023-05-13 19:01:03 +00:00			`futures-util = { version = "0.3.28", optional = true }`
			`tokio = { version = "1.28.1", features = ["macros", "rt-multi-thread"], optional = true }`
			`warp = { version = "0.3.5", default-features = false, features = ["websocket"], optional = true }`
Implement Serve feature 2016-04-02 02:46:05 +00:00
Search with Elasticlunr, updated (#604) * Add search with elasticlunr.js This commit adds search functionality to mdBook, based on work done by @phaiax. The in-browser search code uses elasticlunr.js to execute the search, using an index generated at book build time by elasticlunr-rs. * Add generator comment Someone on Reddit was wondering how the rust book was generated and said they checked the source. Thought I'd put this here. Might be a good idea to have a little footer "made with mdBook", but this'll do for now. * Remove search/editor file override behavior * Use for loop for book iterator * Improve HTML regex * Fix search CORS in file URIs * Use ammonia to sanitize HTML * Filter html5ever log messages 2018-03-07 13:02:06 +00:00			`# Search feature`
Set minimum versions in Cargo.toml 2023-05-13 19:01:03 +00:00			`elasticlunr-rs = { version = "3.0.2", optional = true }`
			`ammonia = { version = "3.3.0", optional = true }`
Search with Elasticlunr, updated (#604) * Add search with elasticlunr.js This commit adds search functionality to mdBook, based on work done by @phaiax. The in-browser search code uses elasticlunr.js to execute the search, using an index generated at book build time by elasticlunr-rs. * Add generator comment Someone on Reddit was wondering how the rust book was generated and said they checked the source. Thought I'd put this here. Might be a good idea to have a little footer "made with mdBook", but this'll do for now. * Remove search/editor file override behavior * Use for loop for book iterator * Improve HTML regex * Fix search CORS in file URIs * Use ammonia to sanitize HTML * Filter html5ever log messages 2018-03-07 13:02:06 +00:00
Regression tests (#422) * Created regression tests for the table of contents * Refactoring to make the test more readable * Fixed some bitrot and removed the (now redundant) tests/helper module * Removed the include_str!() stuff and use just the dummy book for testing * Regression tests now pass again! * Pinned a `` dependency to use a particular version Made sure test mocks return errors instead of panicking * Addressed the rest of @budziq's review * Replaced a file open/read with file_to_string 2017-11-16 07:51:12 +00:00			`[dev-dependencies]`
Set minimum versions in Cargo.toml 2023-05-13 19:01:03 +00:00			`assert_cmd = "2.0.11"`
Update predicates to 3.0.3 2023-07-16 19:42:44 +00:00			`predicates = "3.0.3"`
Update select Update select from 0.5.0 to 0.6.0 https://github.com/utkarshkukreti/select.rs/compare/0.5.0...0.6.0 2022-12-14 16:03:05 +00:00			`select = "0.6.0"`
Set minimum versions in Cargo.toml 2023-05-13 19:01:03 +00:00			`semver = "1.0.17"`
			`pretty_assertions = "1.3.0"`
			`walkdir = "2.3.3"`
Regression tests (#422) * Created regression tests for the table of contents * Refactoring to make the test more readable * Fixed some bitrot and removed the (now redundant) tests/helper module * Removed the include_str!() stuff and use just the dummy book for testing * Regression tests now pass again! * Pinned a `` dependency to use a particular version Made sure test mocks return errors instead of panicking * Addressed the rest of @budziq's review * Replaced a file open/read with file_to_string 2017-11-16 07:51:12 +00:00
Add debug! macro that can be activated using the "debug" feature. #19 2015-08-03 16:06:01 +00:00			`[features]`
Update dependencies. (#1211) * Removed the itertools dependency * Removed an unused feature flag * Stubbed out a toml_query replacement * Update dependencies. * Bump env_logger. * Use warp instead of iron for http server. Iron does not appear to be maintained anymore. warp/hyper seems to be reasonably maintained. Unfortunately this takes a few seconds more to compile, but shouldn't be too bad. One benefit is that there is no longer a need for a separate websocket port, which makes it easier to run multiple servers at once. * Update pulldown-cmark to 0.7 * Switch from error-chain to anyhow. * Bump MSRV to 1.39. * Update elasticlunr-rs. Co-authored-by: Michael Bryan <michaelfbryan@gmail.com> 2020-05-20 21:32:00 +00:00			`default = ["watch", "serve", "search"]`
Switch from gitignore to ignore 2023-04-22 19:49:39 +00:00			`watch = ["dep:notify", "dep:notify-debouncer-mini", "dep:ignore"]`
			`serve = ["dep:futures-util", "dep:tokio", "dep:warp"]`
			`search = ["dep:elasticlunr-rs", "dep:ammonia"]`
Add rustdoc generated API doc 2015-08-06 10:38:48 +00:00
			`[[bin]]`
			`doc = false`
			`name = "mdbook"`
Add test code to show preprocessor developers what the interface data looks like (#1897) This test code will show preprocessor developers what the input data looks like and how to test the preprocessing results. 2022-09-24 21:32:41 +00:00
			`[[example]]`
			`name = "nop-preprocessor"`
			`test = true`