How to Add Examples to Rust Documentation

Add examples to Rust documentation by creating a new listing directory in listings, adding your code, and using the {{#rustdoc_include}} directive in your markdown file.

// In your markdown file (e.g., src/ch01-00-getting-started.md)
{{#rustdoc_include listings/ch01-01-installation/src/main.rs}}

To include only a specific section, wrap the code in // ANCHOR: tag and // ANCHOR_END: tag comments in the source file, then reference the tag in the directive:

{{#rustdoc_include listings/ch01-01-installation/src/main.rs:main_function}}

Adding examples to Rust documentation lets you write code once in a separate file and display it in your book's text. It ensures the code shown to readers is always valid and can be automatically tested. Think of it like linking a spreadsheet cell to a report so the numbers update automatically when the source changes.