499 lines
29 KiB
HTML
499 lines
29 KiB
HTML
|
<!DOCTYPE HTML>
|
||
|
<html lang="en" class="light" dir="ltr">
|
||
|
<head>
|
||
|
<!-- Book generated using mdBook -->
|
||
|
<meta charset="UTF-8">
|
||
|
<title>mdBook-specific features - mdBook Documentation</title>
|
||
|
|
||
|
|
||
|
<!-- Custom HTML head -->
|
||
|
|
||
|
<meta name="description" content="Create book from markdown files. Like Gitbook but implemented in Rust">
|
||
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
|
<meta name="theme-color" content="#ffffff">
|
||
|
|
||
|
<link rel="icon" href="../favicon.svg">
|
||
|
<link rel="shortcut icon" href="../favicon.png">
|
||
|
<link rel="stylesheet" href="../css/variables.css">
|
||
|
<link rel="stylesheet" href="../css/general.css">
|
||
|
<link rel="stylesheet" href="../css/chrome.css">
|
||
|
<link rel="stylesheet" href="../css/print.css" media="print">
|
||
|
|
||
|
<!-- Fonts -->
|
||
|
<link rel="stylesheet" href="../FontAwesome/css/font-awesome.css">
|
||
|
<link rel="stylesheet" href="../fonts/fonts.css">
|
||
|
|
||
|
<!-- Highlight.js Stylesheets -->
|
||
|
<link rel="stylesheet" href="../highlight.css">
|
||
|
<link rel="stylesheet" href="../tomorrow-night.css">
|
||
|
<link rel="stylesheet" href="../ayu-highlight.css">
|
||
|
|
||
|
<!-- Custom theme stylesheets -->
|
||
|
|
||
|
<!-- MathJax -->
|
||
|
<script async src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||
|
</head>
|
||
|
<body class="sidebar-visible no-js">
|
||
|
<div id="body-container">
|
||
|
<!-- Provide site root to javascript -->
|
||
|
<script>
|
||
|
var path_to_root = "../";
|
||
|
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
|
||
|
</script>
|
||
|
|
||
|
<!-- Work around some values being stored in localStorage wrapped in quotes -->
|
||
|
<script>
|
||
|
try {
|
||
|
var theme = localStorage.getItem('mdbook-theme');
|
||
|
var sidebar = localStorage.getItem('mdbook-sidebar');
|
||
|
|
||
|
if (theme.startsWith('"') && theme.endsWith('"')) {
|
||
|
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
|
||
|
}
|
||
|
|
||
|
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
|
||
|
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
|
||
|
}
|
||
|
} catch (e) { }
|
||
|
</script>
|
||
|
|
||
|
<!-- Set the theme before any content is loaded, prevents flash -->
|
||
|
<script>
|
||
|
var theme;
|
||
|
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
|
||
|
if (theme === null || theme === undefined) { theme = default_theme; }
|
||
|
var html = document.querySelector('html');
|
||
|
html.classList.remove('light')
|
||
|
html.classList.add(theme);
|
||
|
var body = document.querySelector('body');
|
||
|
body.classList.remove('no-js')
|
||
|
body.classList.add('js');
|
||
|
</script>
|
||
|
|
||
|
<input type="checkbox" id="sidebar-toggle-anchor" class="hidden">
|
||
|
|
||
|
<!-- Hide / unhide sidebar before it is displayed -->
|
||
|
<script>
|
||
|
var body = document.querySelector('body');
|
||
|
var sidebar = null;
|
||
|
var sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
|
||
|
if (document.body.clientWidth >= 1080) {
|
||
|
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
||
|
sidebar = sidebar || 'visible';
|
||
|
} else {
|
||
|
sidebar = 'hidden';
|
||
|
}
|
||
|
sidebar_toggle.checked = sidebar === 'visible';
|
||
|
body.classList.remove('sidebar-visible');
|
||
|
body.classList.add("sidebar-" + sidebar);
|
||
|
</script>
|
||
|
|
||
|
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
|
||
|
<div class="sidebar-scrollbox">
|
||
|
<ol class="chapter"><li class="chapter-item expanded affix "><a href="../index.html">Introduction</a></li><li class="chapter-item expanded affix "><li class="part-title">User Guide</li><li class="chapter-item expanded "><a href="../guide/installation.html"><strong aria-hidden="true">1.</strong> Installation</a></li><li class="chapter-item expanded "><a href="../guide/reading.html"><strong aria-hidden="true">2.</strong> Reading Books</a></li><li class="chapter-item expanded "><a href="../guide/creating.html"><strong aria-hidden="true">3.</strong> Creating a Book</a></li><li class="chapter-item expanded affix "><li class="part-title">Reference Guide</li><li class="chapter-item expanded "><a href="../cli/index.html"><strong aria-hidden="true">4.</strong> Command Line Tool</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../cli/init.html"><strong aria-hidden="true">4.1.</strong> init</a></li><li class="chapter-item expanded "><a href="../cli/build.html"><strong aria-hidden="true">4.2.</strong> build</a></li><li class="chapter-item expanded "><a href="../cli/watch.html"><strong aria-hidden="true">4.3.</strong> watch</a></li><li class="chapter-item expanded "><a href="../cli/serve.html"><strong aria-hidden="true">4.4.</strong> serve</a></li><li class="chapter-item expanded "><a href="../cli/test.html"><strong aria-hidden="true">4.5.</strong> test</a></li><li class="chapter-item expanded "><a href="../cli/clean.html"><strong aria-hidden="true">4.6.</strong> clean</a></li><li class="chapter-item expanded "><a href="../cli/completions.html"><strong aria-hidden="true">4.7.</strong> completions</a></li></ol></li><li class="chapter-item expanded "><a href="../format/index.html"><strong aria-hidden="true">5.</strong> Format</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../format/summary.html"><strong aria-hidden="true">5.1.</strong> SUMMARY.md</a></li><li><ol class="section"><li class="chapter-item expanded "><div><strong aria-hidden="true">5.1.1.</strong> Draft chapter</div></li></ol></li><li class="chapter-item expanded "><a href="../format/configuration/index.html"><strong aria-hidden="true">5.2.</strong> Configuration</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../format/configuration/general.html"><strong aria-hidden="true">5.2.1.</strong> General</a></li><li class="chapter-item expanded "><a href="../format/configuration/preprocessors.html"><strong aria-hidden="true">5.2.2.</strong> Preprocessors</a></li><li class="chapter-item expanded "><a href="../format/configuration/renderers.html"><strong aria-hidden="true">5.2.3.</strong> Renderers</a></li><li class="chapter-item expanded "><a href="../format/configuration/environment-variables.html"><strong aria-hidden="true">5.2.4.</strong> Environment Variables</a></li></ol></li><li class="chapter-item expanded "><a href="../format/theme/index.html"><strong aria-hidden="true">5.3.</strong> Theme</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../format/theme/index-hbs.html"><strong aria-hidden="true">5.3.1.</strong> index.hbs</a></li><li class="chapter-item expanded "><a href="../format/theme/syntax-highlighting.html"><strong aria-hidden="true">5.3.2.</strong> Syntax highlighting</a></li><li class="chapter-item expanded "><a href="../format/theme/editor.html"><strong aria-hidden="true">5.3.3.</strong> Editor</a></li></ol></li><li class="chapter-item expanded "><a href="../format/mathjax.html"><strong aria-hidden="true">5.4.</strong> MathJax Support</a></li><li class="chapter-item expanded "><a href="../format/mdbook.html" class="active"><strong aria-hidden="true">5.5.</strong> mdBook-specific features</a></li><li class="chapter-item expanded "><a href="../format/markdown.html"><strong aria-hidden="true">5.6.</strong> Markdown</a></li></ol></li><li class="chapter-item expanded "><a href="../continuous-integration.html"><strong aria-hidden="true">6.</strong> Continuous Integration</a></li><li class="chapter-item expanded "><a href="../for_developers/index
|
||
|
</div>
|
||
|
<div id="sidebar-resize-handle" class="sidebar-resize-handle">
|
||
|
<div class="sidebar-resize-indicator"></div>
|
||
|
</div>
|
||
|
</nav>
|
||
|
|
||
|
<!-- Track and set sidebar scroll position -->
|
||
|
<script>
|
||
|
var sidebarScrollbox = document.querySelector('#sidebar .sidebar-scrollbox');
|
||
|
sidebarScrollbox.addEventListener('click', function(e) {
|
||
|
if (e.target.tagName === 'A') {
|
||
|
sessionStorage.setItem('sidebar-scroll', sidebarScrollbox.scrollTop);
|
||
|
}
|
||
|
}, { passive: true });
|
||
|
var sidebarScrollTop = sessionStorage.getItem('sidebar-scroll');
|
||
|
sessionStorage.removeItem('sidebar-scroll');
|
||
|
if (sidebarScrollTop) {
|
||
|
// preserve sidebar scroll position when navigating via links within sidebar
|
||
|
sidebarScrollbox.scrollTop = sidebarScrollTop;
|
||
|
} else {
|
||
|
// scroll sidebar to current active section when navigating via "next/previous chapter" buttons
|
||
|
var activeSection = document.querySelector('#sidebar .active');
|
||
|
if (activeSection) {
|
||
|
activeSection.scrollIntoView({ block: 'center' });
|
||
|
}
|
||
|
}
|
||
|
</script>
|
||
|
|
||
|
<div id="page-wrapper" class="page-wrapper">
|
||
|
|
||
|
<div class="page">
|
||
|
<div id="menu-bar-hover-placeholder"></div>
|
||
|
<div id="menu-bar" class="menu-bar sticky">
|
||
|
<div class="left-buttons">
|
||
|
<label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
|
||
|
<i class="fa fa-bars"></i>
|
||
|
</label>
|
||
|
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
|
||
|
<i class="fa fa-paint-brush"></i>
|
||
|
</button>
|
||
|
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
|
||
|
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
|
||
|
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
|
||
|
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
|
||
|
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
|
||
|
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
|
||
|
</ul>
|
||
|
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
|
||
|
<i class="fa fa-search"></i>
|
||
|
</button>
|
||
|
</div>
|
||
|
|
||
|
<h1 class="menu-title">mdBook Documentation</h1>
|
||
|
|
||
|
<div class="right-buttons">
|
||
|
<a href="../print.html" title="Print this book" aria-label="Print this book">
|
||
|
<i id="print-button" class="fa fa-print"></i>
|
||
|
</a>
|
||
|
<a href="https://github.com/rust-lang/mdBook/tree/master/guide" title="Git repository" aria-label="Git repository">
|
||
|
<i id="git-repository-button" class="fa fa-github"></i>
|
||
|
</a>
|
||
|
<a href="https://github.com/rust-lang/mdBook/edit/master/guide/src/format/mdbook.md" title="Suggest an edit" aria-label="Suggest an edit">
|
||
|
<i id="git-edit-button" class="fa fa-edit"></i>
|
||
|
</a>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
|
||
|
<div id="search-wrapper" class="hidden">
|
||
|
<form id="searchbar-outer" class="searchbar-outer">
|
||
|
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
|
||
|
</form>
|
||
|
<div id="searchresults-outer" class="searchresults-outer hidden">
|
||
|
<div id="searchresults-header" class="searchresults-header"></div>
|
||
|
<ul id="searchresults">
|
||
|
</ul>
|
||
|
</div>
|
||
|
</div>
|
||
|
|
||
|
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
|
||
|
<script>
|
||
|
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
|
||
|
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
|
||
|
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
|
||
|
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
|
||
|
});
|
||
|
</script>
|
||
|
|
||
|
<div id="content" class="content">
|
||
|
<main>
|
||
|
<h1 id="mdbook-specific-features"><a class="header" href="#mdbook-specific-features">mdBook-specific features</a></h1>
|
||
|
<h2 id="hiding-code-lines"><a class="header" href="#hiding-code-lines">Hiding code lines</a></h2>
|
||
|
<p>There is a feature in mdBook that lets you hide code lines by prepending them with a specific prefix.</p>
|
||
|
<p>For the Rust language, you can use the <code>#</code> character as a prefix which will hide lines <a href="https://doc.rust-lang.org/stable/rustdoc/write-documentation/documentation-tests.html#hiding-portions-of-the-example">like you would with Rustdoc</a>.</p>
|
||
|
<pre><code class="language-bash"># fn main() {
|
||
|
let x = 5;
|
||
|
let y = 6;
|
||
|
|
||
|
println!("{}", x + y);
|
||
|
# }
|
||
|
</code></pre>
|
||
|
<p>Will render as</p>
|
||
|
<pre><pre class="playground"><code class="language-rust edition2018"><span class="boring">fn main() {
|
||
|
</span> let x = 5;
|
||
|
let y = 6;
|
||
|
|
||
|
println!("{}", x + y);
|
||
|
<span class="boring">}</span></code></pre></pre>
|
||
|
<p>When you tap or hover the mouse over the code block, there will be an eyeball icon (<i class="fa fa-eye"></i>) which will toggle the visibility of the hidden lines.</p>
|
||
|
<p>By default, this only works for code examples that are annotated with <code>rust</code>.
|
||
|
However, you can define custom prefixes for other languages by adding a new line-hiding prefix in your <code>book.toml</code> with the language name and prefix character(s):</p>
|
||
|
<pre><code class="language-toml">[output.html.code.hidelines]
|
||
|
python = "~"
|
||
|
</code></pre>
|
||
|
<p>The prefix will hide any lines that begin with the given prefix. With the python prefix shown above, this:</p>
|
||
|
<pre><code class="language-bash">~hidden()
|
||
|
nothidden():
|
||
|
~ hidden()
|
||
|
~hidden()
|
||
|
nothidden()
|
||
|
</code></pre>
|
||
|
<p>will render as</p>
|
||
|
<pre><code class="language-python"><span class="boring">hidden()
|
||
|
</span>nothidden():
|
||
|
<span class="boring"> hidden()
|
||
|
</span><span class="boring"> hidden()
|
||
|
</span> nothidden()
|
||
|
</code></pre>
|
||
|
<p>This behavior can be overridden locally with a different prefix. This has the same effect as above:</p>
|
||
|
<pre><code class="language-markdown">```python,hidelines=!!!
|
||
|
!!!hidden()
|
||
|
nothidden():
|
||
|
!!! hidden()
|
||
|
!!!hidden()
|
||
|
nothidden()
|
||
|
```
|
||
|
</code></pre>
|
||
|
<h2 id="rust-playground"><a class="header" href="#rust-playground">Rust Playground</a></h2>
|
||
|
<p>Rust language code blocks will automatically get a play button (<i class="fa fa-play"></i>) which will execute the code and display the output just below the code block.
|
||
|
This works by sending the code to the <a href="https://play.rust-lang.org/">Rust Playground</a>.</p>
|
||
|
<pre><pre class="playground"><code class="language-rust edition2018"><span class="boring">#![allow(unused)]
|
||
|
</span><span class="boring">fn main() {
|
||
|
</span>println!("Hello, World!");
|
||
|
<span class="boring">}</span></code></pre></pre>
|
||
|
<p>If there is no <code>main</code> function, then the code is automatically wrapped inside one.</p>
|
||
|
<p>If you wish to disable the play button for a code block, you can include the <code>noplayground</code> option on the code block like this:</p>
|
||
|
<pre><code class="language-markdown">```rust,noplayground
|
||
|
let mut name = String::new();
|
||
|
std::io::stdin().read_line(&mut name).expect("failed to read line");
|
||
|
println!("Hello {}!", name);
|
||
|
```
|
||
|
</code></pre>
|
||
|
<p>Or, if you wish to disable the play button for all code blocks in your book, you can write the config to the <code>book.toml</code> like this.</p>
|
||
|
<pre><code class="language-toml">[output.html.playground]
|
||
|
runnable = false
|
||
|
</code></pre>
|
||
|
<h2 id="rust-code-block-attributes"><a class="header" href="#rust-code-block-attributes">Rust code block attributes</a></h2>
|
||
|
<p>Additional attributes can be included in Rust code blocks with comma, space, or tab-separated terms just after the language term. For example:</p>
|
||
|
<pre><code class="language-markdown">```rust,ignore
|
||
|
# This example won't be tested.
|
||
|
panic!("oops!");
|
||
|
```
|
||
|
</code></pre>
|
||
|
<p>These are particularly important when using <a href="../cli/test.html"><code>mdbook test</code></a> to test Rust examples.
|
||
|
These use the same attributes as <a href="https://doc.rust-lang.org/rustdoc/documentation-tests.html#attributes">rustdoc attributes</a>, with a few additions:</p>
|
||
|
<ul>
|
||
|
<li><code>editable</code> — Enables the <a href="theme/editor.html">editor</a>.</li>
|
||
|
<li><code>noplayground</code> — Removes the play button, but will still be tested.</li>
|
||
|
<li><code>mdbook-runnable</code> — Forces the play button to be displayed.
|
||
|
This is intended to be combined with the <code>ignore</code> attribute for examples that should not be tested, but you want to allow the reader to run.</li>
|
||
|
<li><code>ignore</code> — Will not be tested and no play button is shown, but it is still highlighted as Rust syntax.</li>
|
||
|
<li><code>should_panic</code> — When executed, it should produce a panic.</li>
|
||
|
<li><code>no_run</code> — The code is compiled when tested, but it is not run.
|
||
|
The play button is also not shown.</li>
|
||
|
<li><code>compile_fail</code> — The code should fail to compile.</li>
|
||
|
<li><code>edition2015</code>, <code>edition2018</code>, <code>edition2021</code> — Forces the use of a specific Rust edition.
|
||
|
See <a href="configuration/general.html#rust-options"><code>rust.edition</code></a> to set this globally.</li>
|
||
|
</ul>
|
||
|
<h2 id="including-files"><a class="header" href="#including-files">Including files</a></h2>
|
||
|
<p>With the following syntax, you can include files into your book:</p>
|
||
|
<pre><code class="language-hbs">{{#include file.rs}}
|
||
|
</code></pre>
|
||
|
<p>The path to the file has to be relative from the current source file.</p>
|
||
|
<p>mdBook will interpret included files as Markdown. Since the include command
|
||
|
is usually used for inserting code snippets and examples, you will often
|
||
|
wrap the command with <code>```</code> to display the file contents without
|
||
|
interpreting them.</p>
|
||
|
<pre><code class="language-hbs">```
|
||
|
{{#include file.rs}}
|
||
|
```
|
||
|
</code></pre>
|
||
|
<h2 id="including-portions-of-a-file"><a class="header" href="#including-portions-of-a-file">Including portions of a file</a></h2>
|
||
|
<p>Often you only need a specific part of the file, e.g. relevant lines for an
|
||
|
example. We support four different modes of partial includes:</p>
|
||
|
<pre><code class="language-hbs">{{#include file.rs:2}}
|
||
|
{{#include file.rs::10}}
|
||
|
{{#include file.rs:2:}}
|
||
|
{{#include file.rs:2:10}}
|
||
|
</code></pre>
|
||
|
<p>The first command only includes the second line from file <code>file.rs</code>. The second
|
||
|
command includes all lines up to line 10, i.e. the lines from 11 till the end of
|
||
|
the file are omitted. The third command includes all lines from line 2, i.e. the
|
||
|
first line is omitted. The last command includes the excerpt of <code>file.rs</code>
|
||
|
consisting of lines 2 to 10.</p>
|
||
|
<p>To avoid breaking your book when modifying included files, you can also
|
||
|
include a specific section using anchors instead of line numbers.
|
||
|
An anchor is a pair of matching lines. The line beginning an anchor must
|
||
|
match the regex <code>ANCHOR:\s*[\w_-]+</code> and similarly the ending line must match
|
||
|
the regex <code>ANCHOR_END:\s*[\w_-]+</code>. This allows you to put anchors in
|
||
|
any kind of commented line.</p>
|
||
|
<p>Consider the following file to include:</p>
|
||
|
<pre><code class="language-rs">/* ANCHOR: all */
|
||
|
|
||
|
// ANCHOR: component
|
||
|
struct Paddle {
|
||
|
hello: f32,
|
||
|
}
|
||
|
// ANCHOR_END: component
|
||
|
|
||
|
////////// ANCHOR: system
|
||
|
impl System for MySystem { ... }
|
||
|
////////// ANCHOR_END: system
|
||
|
|
||
|
/* ANCHOR_END: all */
|
||
|
</code></pre>
|
||
|
<p>Then in the book, all you have to do is:</p>
|
||
|
<pre><code class="language-hbs">Here is a component:
|
||
|
```rust,no_run,noplayground
|
||
|
{{#include file.rs:component}}
|
||
|
```
|
||
|
|
||
|
Here is a system:
|
||
|
```rust,no_run,noplayground
|
||
|
{{#include file.rs:system}}
|
||
|
```
|
||
|
|
||
|
This is the full file.
|
||
|
```rust,no_run,noplayground
|
||
|
{{#include file.rs:all}}
|
||
|
```
|
||
|
</code></pre>
|
||
|
<p>Lines containing anchor patterns inside the included anchor are ignored.</p>
|
||
|
<h2 id="including-a-file-but-initially-hiding-all-except-specified-lines"><a class="header" href="#including-a-file-but-initially-hiding-all-except-specified-lines">Including a file but initially hiding all except specified lines</a></h2>
|
||
|
<p>The <code>rustdoc_include</code> helper is for including code from external Rust files that contain complete
|
||
|
examples, but only initially showing particular lines specified with line numbers or anchors in the
|
||
|
same way as with <code>include</code>.</p>
|
||
|
<p>The lines not in the line number range or between the anchors will still be included, but they will
|
||
|
be prefaced with <code>#</code>. This way, a reader can expand the snippet to see the complete example, and
|
||
|
Rustdoc will use the complete example when you run <code>mdbook test</code>.</p>
|
||
|
<p>For example, consider a file named <code>file.rs</code> that contains this Rust program:</p>
|
||
|
<pre><pre class="playground"><code class="language-rust edition2018">fn main() {
|
||
|
let x = add_one(2);
|
||
|
assert_eq!(x, 3);
|
||
|
}
|
||
|
|
||
|
fn add_one(num: i32) -> i32 {
|
||
|
num + 1
|
||
|
}</code></pre></pre>
|
||
|
<p>We can include a snippet that initially shows only line 2 by using this syntax:</p>
|
||
|
<pre><code class="language-hbs">To call the `add_one` function, we pass it an `i32` and bind the returned value to `x`:
|
||
|
|
||
|
```rust
|
||
|
{{#rustdoc_include file.rs:2}}
|
||
|
```
|
||
|
</code></pre>
|
||
|
<p>This would have the same effect as if we had manually inserted the code and hidden all but line 2
|
||
|
using <code>#</code>:</p>
|
||
|
<pre><code class="language-hbs">To call the `add_one` function, we pass it an `i32` and bind the returned value to `x`:
|
||
|
|
||
|
```rust
|
||
|
# fn main() {
|
||
|
let x = add_one(2);
|
||
|
# assert_eq!(x, 3);
|
||
|
# }
|
||
|
#
|
||
|
# fn add_one(num: i32) -> i32 {
|
||
|
# num + 1
|
||
|
# }
|
||
|
```
|
||
|
</code></pre>
|
||
|
<p>That is, it looks like this (click the "expand" icon to see the rest of the file):</p>
|
||
|
<pre><pre class="playground"><code class="language-rust edition2018"><span class="boring">fn main() {
|
||
|
</span> let x = add_one(2);
|
||
|
<span class="boring"> assert_eq!(x, 3);
|
||
|
</span><span class="boring">}
|
||
|
</span><span class="boring">
|
||
|
</span><span class="boring">fn add_one(num: i32) -> i32 {
|
||
|
</span><span class="boring"> num + 1
|
||
|
</span><span class="boring">}</span></code></pre></pre>
|
||
|
<h2 id="inserting-runnable-rust-files"><a class="header" href="#inserting-runnable-rust-files">Inserting runnable Rust files</a></h2>
|
||
|
<p>With the following syntax, you can insert runnable Rust files into your book:</p>
|
||
|
<pre><code class="language-hbs">{{#playground file.rs}}
|
||
|
</code></pre>
|
||
|
<p>The path to the Rust file has to be relative from the current source file.</p>
|
||
|
<p>When play is clicked, the code snippet will be sent to the <a href="https://play.rust-lang.org/">Rust Playground</a> to be
|
||
|
compiled and run. The result is sent back and displayed directly underneath the
|
||
|
code.</p>
|
||
|
<p>Here is what a rendered code snippet looks like:</p>
|
||
|
<pre><pre class="playground"><code class="language-rust edition2018">fn main() {
|
||
|
println!("Hello World!");
|
||
|
<span class="boring">
|
||
|
</span><span class="boring"> // You can even hide lines! :D
|
||
|
</span><span class="boring"> println!("I am hidden! Expand the code snippet to see me");
|
||
|
</span>}</code></pre></pre>
|
||
|
<p>Any additional values passed after the filename will be included as attributes of the code block.
|
||
|
For example <code>{{#playground example.rs editable}}</code> will create the code block like the following:</p>
|
||
|
<pre><code class="language-markdown">```rust,editable
|
||
|
# Contents of example.rs here.
|
||
|
```
|
||
|
</code></pre>
|
||
|
<p>And the <code>editable</code> attribute will enable the <a href="theme/editor.html">editor</a> as described at <a href="#rust-code-block-attributes">Rust code block attributes</a>.</p>
|
||
|
<h2 id="controlling-page-title"><a class="header" href="#controlling-page-title">Controlling page <title></a></h2>
|
||
|
<p>A chapter can set a <title> that is different from its entry in the table of
|
||
|
contents (sidebar) by including a <code>{{#title ...}}</code> near the top of the page.</p>
|
||
|
<pre><code class="language-hbs">{{#title My Title}}
|
||
|
</code></pre>
|
||
|
<h2 id="html-classes-provided-by-mdbook"><a class="header" href="#html-classes-provided-by-mdbook">HTML classes provided by mdBook</a></h2>
|
||
|
<img class="right" src="images/rust-logo-blk.svg" alt="The Rust logo">
|
||
|
<h3 id="classleft-and-right"><a class="header" href="#classleft-and-right"><code>class="left"</code> and <code>"right"</code></a></h3>
|
||
|
<p>These classes are provided by default, for inline HTML to float images.</p>
|
||
|
<pre><code class="language-html"><img class="right" src="images/rust-logo-blk.svg" alt="The Rust logo">
|
||
|
</code></pre>
|
||
|
<h3 id="classhidden"><a class="header" href="#classhidden"><code>class="hidden"</code></a></h3>
|
||
|
<p>HTML tags with class <code>hidden</code> will not be shown.</p>
|
||
|
<pre><code class="language-html"><div class="hidden">This will not be seen.</div>
|
||
|
</code></pre>
|
||
|
<div class="hidden">This will not be seen.</div>
|
||
|
<h3 id="classwarning"><a class="header" href="#classwarning"><code>class="warning"</code></a></h3>
|
||
|
<p>To make a warning or similar note stand out, wrap it in a warning div.</p>
|
||
|
<pre><code class="language-html"><div class="warning">
|
||
|
|
||
|
This is a bad thing that you should pay attention to.
|
||
|
|
||
|
Warning blocks should be used sparingly in documentation, to avoid "warning
|
||
|
fatigue," where people are trained to ignore them because they usually don't
|
||
|
matter for what they're doing.
|
||
|
|
||
|
</div>
|
||
|
</code></pre>
|
||
|
<div class="warning">
|
||
|
<p>This is a bad thing that you should pay attention to.</p>
|
||
|
<p>Warning blocks should be used sparingly in documentation, to avoid "warning
|
||
|
fatigue," where people are trained to ignore them because they usually don't
|
||
|
matter for what they're doing.</p>
|
||
|
</div>
|
||
|
|
||
|
</main>
|
||
|
|
||
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
||
|
<!-- Mobile navigation buttons -->
|
||
|
<a rel="prev" href="../format/mathjax.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
||
|
<i class="fa fa-angle-left"></i>
|
||
|
</a>
|
||
|
|
||
|
<a rel="next prefetch" href="../format/markdown.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
||
|
<i class="fa fa-angle-right"></i>
|
||
|
</a>
|
||
|
|
||
|
<div style="clear: both"></div>
|
||
|
</nav>
|
||
|
</div>
|
||
|
</div>
|
||
|
|
||
|
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
||
|
<a rel="prev" href="../format/mathjax.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
||
|
<i class="fa fa-angle-left"></i>
|
||
|
</a>
|
||
|
|
||
|
<a rel="next prefetch" href="../format/markdown.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
||
|
<i class="fa fa-angle-right"></i>
|
||
|
</a>
|
||
|
</nav>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
<script>
|
||
|
window.playground_line_numbers = true;
|
||
|
</script>
|
||
|
|
||
|
<script>
|
||
|
window.playground_copyable = true;
|
||
|
</script>
|
||
|
|
||
|
<script src="../ace.js"></script>
|
||
|
<script src="../editor.js"></script>
|
||
|
<script src="../mode-rust.js"></script>
|
||
|
<script src="../theme-dawn.js"></script>
|
||
|
<script src="../theme-tomorrow_night.js"></script>
|
||
|
|
||
|
<script src="../elasticlunr.min.js"></script>
|
||
|
<script src="../mark.min.js"></script>
|
||
|
<script src="../searcher.js"></script>
|
||
|
|
||
|
<script src="../clipboard.min.js"></script>
|
||
|
<script src="../highlight.js"></script>
|
||
|
<script src="../book.js"></script>
|
||
|
|
||
|
<!-- Custom JS scripts -->
|
||
|
|
||
|
|
||
|
</div>
|
||
|
</body>
|
||
|
</html>
|