mdBook/guide/book.toml

[book]
title = "mdBook Documentation"
description = "Create book from markdown files. Like Gitbook but implemented in Rust"
authors = ["Mathieu David", "Michael-F-Bryan"]
language = "en"

[rust]
edition = "2018"

[output.html]
smart-punctuation = true
mathjax-support = true
site-url = "/mdBook/"
git-repository-url = "https://github.com/rust-lang/mdBook/tree/master/guide"
edit-url-template = "https://github.com/rust-lang/mdBook/edit/master/guide/{path}"
hash-files = true

[output.html.playground]
editable = true
line-numbers = true

[output.html.code.hidelines]
python = "~"

[output.html.search]
limit-results = 20
use-boolean-and = true
boost-title = 2
boost-hierarchy = 2
boost-paragraph = 1
expand = true
heading-split-level = 2

[output.html.redirect]
"/format/config.html" = "configuration/index.html"
Made sure the dummy book can build 2017-11-18 22:07:08 +08:00			`[book]`
update example to encourage using book.toml 2016-12-23 08:17:04 +00:00			`title = "mdBook Documentation"`
			`description = "Create book from markdown files. Like Gitbook but implemented in Rust"`
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 2018-01-21 22:35:11 +08:00			`authors = ["Mathieu David", "Michael-F-Bryan"]`
update language attribute to configurable 2019-05-30 11:53:49 +09:00			`language = "en"`
Some edition cleanup and fixes. 2020-04-21 12:21:56 -07:00
			`[rust]`
Add support for Rust edition 2019-11-17 21:36:10 +03:00			`edition = "2018"`
Update documentation for mathjax 2017-08-10 18:11:26 +02:00
			`[output.html]`
docs: Switch the guide to use smart punctuation. 2024-05-13 13:43:00 -07:00			`smart-punctuation = true`
Made sure the dummy book can build 2017-11-18 22:07:08 +08:00			`mathjax-support = true`
additional changes to the 404 mechanism based on feedback: - removed config output_404 - ensure serve overrides the site url, and hosts the correct 404 file - refactor 404 rendering into separate fn - formatting 2020-06-10 12:31:34 +02:00			`site-url = "/mdBook/"`
Add git repository url link to user guide. 2021-02-12 07:34:20 -08:00			`git-repository-url = "https://github.com/rust-lang/mdBook/tree/master/guide"`
Rename git-repository-edit-url-template Change the name of the git-repository-edit-url-template to be more generic: `edit-url-template` Signed-off-by: Flavio Castelli <fcastelli@suse.com> 2021-04-26 09:59:08 +02:00			`edit-url-template = "https://github.com/rust-lang/mdBook/edit/master/guide/{path}"`
feat(html): cache bust static files by adding hashes to file names Closes rust-lang#1254 2025-02-13 10:04:21 -07:00			`hash-files = true`
Documenting the editor #521 2018-01-16 21:26:13 -08:00
Rename playpen to playground. (#1241) looks good 2020-06-22 07:34:25 -07:00			`[output.html.playground]`
Documenting the editor #521 2018-01-16 21:26:13 -08:00			`editable = true`
Added line numbers to editable sections of code. - Added line numbers to config struct - Added playpen_line_numbers field to hbs renderer. - Added section to set `window.playpen_line_numbers = true` in page template - Use line number global variable to show line numbers when required. 2019-09-24 21:27:02 +08:00			`line-numbers = 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 07:02:06 -06:00
Support hidden lines in languages other than Rust Co-Authored-By: thecodewarrior <5467669+thecodewarrior@users.noreply.github.com> 2022-02-23 01:02:54 +01:00			`[output.html.code.hidelines]`
			`python = "~"`

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 07:02:06 -06:00			`[output.html.search]`
			`limit-results = 20`
			`use-boolean-and = true`
			`boost-title = 2`
			`boost-hierarchy = 2`
			`boost-paragraph = 1`
			`expand = true`
			`heading-split-level = 2`
restructure guide configuration section restructure guide configuration section restructure guide configuration section redirect to new config top level fix broken links use a relative path for redirect Co-authored-by: Eric Huss <eric@huss.org> remove extra heading 2021-05-23 17:59:52 -07:00
			`[output.html.redirect]`
			`"/format/config.html" = "configuration/index.html"`