mdBook/book-example/src/format
Carol (Nichols || Goulding) a873d46871 Implement a markdown renderer (#1018)
Use case: when trying to `mdbook test` a file that has many `include`
directives, and a test fails, the line numbers in the `rustdoc` output
don't match the line numbers in the original markdown file.

Turning on the markdown renderer implemented here lets you see what is
being passed to `rustdoc` by saving the markdown after the preprocessors
have run.

This renderer could be helpful for debugging many preprocessors, but
it's probably not useful in the general case, so it's turned off by
default.
2019-08-30 12:20:53 +02:00
..
theme update language attribute to configurable 2019-05-30 11:53:49 +09:00
README.md Add index preprocessor (#685) 2018-05-04 19:41:28 +08:00
config.md Implement a markdown renderer (#1018) 2019-08-30 12:20:53 +02:00
example.rs #29 update doc with an example of runnable rust code 2016-01-01 01:57:21 +01:00
mathjax.md Rewrap guide markdown at 80 columns 2018-08-02 21:34:26 -05:00
mdbook.md Document anchor-based partial include feature in the book 2019-07-14 21:55:51 -04:00
summary.md Rewrap guide markdown at 80 columns 2018-08-02 21:34:26 -05:00

README.md

Format

In this section you will learn how to:

  • Structure your book correctly
  • Format your SUMMARY.md file
  • Configure your book using book.toml
  • Customize your theme