mdbook/guide/src/SUMMARY.md

# Summary

[Introduction](README.md)

# User guide

- [Installation](guide/installation.md)
- [Reading books](guide/reading.md)
- [Creating a book](guide/creating.md)

# Reference guide

- [Command-line tool](cli/README.md)
    - [init](cli/init.md)
    - [build](cli/build.md)
    - [watch](cli/watch.md)
    - [serve](cli/serve.md)
    - [test](cli/test.md)
    - [clean](cli/clean.md)
    - [completions](cli/completions.md)
- [Format](format/README.md)
    - [SUMMARY.md](format/summary.md)
        - [Draft chapter]()
    - [Configuration](format/configuration/README.md)
        - [General](format/configuration/general.md)
        - [Preprocessors](format/configuration/preprocessors.md)
        - [Renderers](format/configuration/renderers.md)
        - [Environment variables](format/configuration/environment-variables.md)
    - [Theme](format/theme/README.md)
        - [index.hbs](format/theme/index-hbs.md)
        - [Syntax highlighting](format/theme/syntax-highlighting.md)
        - [Editor](format/theme/editor.md)
    - [MathJax support](format/mathjax.md)
    - [mdBook-specific features](format/mdbook.md)
    - [Markdown](format/markdown.md)
- [Continuous integration](continuous-integration.md)
- [For developers](for_developers/README.md)
    - [Preprocessors](for_developers/preprocessors.md)
    - [Alternative backends](for_developers/backends.md)

-----------

[Contributors](misc/contributors.md)
Added an example book also containing the docs 2015-07-30 11:59:08 +02:00			`# Summary`

Update documentation 2021-12-19 20:26:37 -08:00			`[Introduction](README.md)`

Use consistent sentence case for section headers There was a mix of different capitalization here, so I'm just going to pick the one we use most often. 2025-08-16 14:52:07 -07:00			`# User guide`
Update documentation 2021-12-19 20:26:37 -08:00
			`- [Installation](guide/installation.md)`
Use consistent sentence case for section headers There was a mix of different capitalization here, so I'm just going to pick the one we use most often. 2025-08-16 14:52:07 -07:00			`- [Reading books](guide/reading.md)`
			`- [Creating a book](guide/creating.md)`
Update documentation 2021-12-19 20:26:37 -08:00
Use consistent sentence case for section headers There was a mix of different capitalization here, so I'm just going to pick the one we use most often. 2025-08-16 14:52:07 -07:00			`# Reference guide`
Update documentation 2021-12-19 20:26:37 -08:00
Use consistent sentence case for section headers There was a mix of different capitalization here, so I'm just going to pick the one we use most often. 2025-08-16 14:52:07 -07:00			`- [Command-line tool](cli/README.md)`
Added an example book also containing the docs 2015-07-30 11:59:08 +02:00			`- [init](cli/init.md)`
			`- [build](cli/build.md)`
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 14:31:00 +01:00			`- [watch](cli/watch.md)`
Added option to configure serve interface and address browser will use to connect to websocket server. 2016-08-05 21:40:00 +00:00			`- [serve](cli/serve.md)`
fix mdbook test for the book 2015-12-29 17:59:08 -05:00			`- [test](cli/test.md)`
Update documentation to reflect addition of `clean` subcommand. (#607) * update documentation Update README.md and User Guide to reflect addition of `clean` subcommand. Do minor spelling fixes too. * fix grammar in `clean` documentation 2018-02-18 10:04:04 +03:00			`- [clean](cli/clean.md)`
Update documentation 2021-12-19 20:26:37 -08:00			`- [completions](cli/completions.md)`
Add index preprocessor (#685) * Add index preprocessor README.md is a de facto index file in markdown-based documentation. Hence, we respect to README.md and convert it into index.html. * Fix warning for unused variables * Update tests for config * Match file stem case-insensitively for IndexPreprocessor * Add tests for IndexPreprocessor * Update book example to fit index preprocessor 2018-05-04 19:41:28 +08:00			`- [Format](format/README.md)`
Added some chapters for the documentation #30 + tweaked the syntax highlighting theme 2015-08-05 20:36:21 +02:00			`- [SUMMARY.md](format/summary.md)`
Bring back draft chapters 2020-02-29 17:55:45 +01:00			`- [Draft chapter]()`
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			`- [Configuration](format/configuration/README.md)`
			`- [General](format/configuration/general.md)`
			`- [Preprocessors](format/configuration/preprocessors.md)`
			`- [Renderers](format/configuration/renderers.md)`
Use consistent sentence case for section headers There was a mix of different capitalization here, so I'm just going to pick the one we use most often. 2025-08-16 14:52:07 -07:00			`- [Environment variables](format/configuration/environment-variables.md)`
Add index preprocessor (#685) * Add index preprocessor README.md is a de facto index file in markdown-based documentation. Hence, we respect to README.md and convert it into index.html. * Fix warning for unused variables * Update tests for config * Match file stem case-insensitively for IndexPreprocessor * Add tests for IndexPreprocessor * Update book example to fit index preprocessor 2018-05-04 19:41:28 +08:00			`- [Theme](format/theme/README.md)`
Added some chapters for the documentation #30 + tweaked the syntax highlighting theme 2015-08-05 20:36:21 +02:00			`- [index.hbs](format/theme/index-hbs.md)`
			`- [Syntax highlighting](format/theme/syntax-highlighting.md)`
Documenting the editor #521 2018-01-16 21:26:13 -08:00			`- [Editor](format/theme/editor.md)`
Use consistent sentence case for section headers There was a mix of different capitalization here, so I'm just going to pick the one we use most often. 2025-08-16 14:52:07 -07:00			`- [MathJax support](format/mathjax.md)`
List supported Highlight.js languages in guide (#1345) * List supported Highlight.js languages in guide Generated using the technique described in https://github.com/rust-lang/mdBook/issues/1275#issuecomment-655903967. * Improve wording in guide 2020-09-29 16:56:31 -07:00			`- [mdBook-specific features](format/mdbook.md)`
add a markdown page 2021-12-17 19:08:21 -08:00			`- [Markdown](format/markdown.md)`
Use consistent sentence case for section headers There was a mix of different capitalization here, so I'm just going to pick the one we use most often. 2025-08-16 14:52:07 -07:00			`- [Continuous integration](continuous-integration.md)`
			`- [For developers](for_developers/README.md)`
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			`- [Preprocessors](for_developers/preprocessors.md)`
Use consistent sentence case for section headers There was a mix of different capitalization here, so I'm just going to pick the one we use most often. 2025-08-16 14:52:07 -07:00			`- [Alternative backends](for_developers/backends.md)`
Add index preprocessor (#685) * Add index preprocessor README.md is a de facto index file in markdown-based documentation. Hence, we respect to README.md and convert it into index.html. * Fix warning for unused variables * Update tests for config * Match file stem case-insensitively for IndexPreprocessor * Add tests for IndexPreprocessor * Update book example to fit index preprocessor 2018-05-04 19:41:28 +08:00
Big refactoring, now using enum for different book items (Chapter, Affix, Spacer, ...) Closes #9 2015-09-11 20:52:55 +02:00			`-----------`
Add index preprocessor (#685) * Add index preprocessor README.md is a de facto index file in markdown-based documentation. Hence, we respect to README.md and convert it into index.html. * Fix warning for unused variables * Update tests for config * Match file stem case-insensitively for IndexPreprocessor * Add tests for IndexPreprocessor * Update book example to fit index preprocessor 2018-05-04 19:41:28 +08:00
Big refactoring, now using enum for different book items (Chapter, Affix, Spacer, ...) Closes #9 2015-09-11 20:52:55 +02:00			`[Contributors](misc/contributors.md)`