355 lines
21 KiB
HTML
355 lines
21 KiB
HTML
|
<!DOCTYPE HTML>
|
||
|
<html lang="en" class="light" dir="ltr">
|
||
|
<head>
|
||
|
<!-- Book generated using mdBook -->
|
||
|
<meta charset="UTF-8">
|
||
|
<title>General - 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" class="active"><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"><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 Integr
|
||
|
</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/configuration/general.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="general-configuration"><a class="header" href="#general-configuration">General Configuration</a></h1>
|
||
|
<p>You can configure the parameters for your book in the <em><strong>book.toml</strong></em> file.</p>
|
||
|
<p>Here is an example of what a <em><strong>book.toml</strong></em> file might look like:</p>
|
||
|
<pre><code class="language-toml">[book]
|
||
|
title = "Example book"
|
||
|
authors = ["John Doe"]
|
||
|
description = "The example book covers examples."
|
||
|
|
||
|
[rust]
|
||
|
edition = "2018"
|
||
|
|
||
|
[build]
|
||
|
build-dir = "my-example-book"
|
||
|
create-missing = false
|
||
|
|
||
|
[preprocessor.index]
|
||
|
|
||
|
[preprocessor.links]
|
||
|
|
||
|
[output.html]
|
||
|
additional-css = ["custom.css"]
|
||
|
|
||
|
[output.html.search]
|
||
|
limit-results = 15
|
||
|
</code></pre>
|
||
|
<h2 id="supported-configuration-options"><a class="header" href="#supported-configuration-options">Supported configuration options</a></h2>
|
||
|
<p>It is important to note that <strong>any</strong> relative path specified in the
|
||
|
configuration will always be taken relative from the root of the book where the
|
||
|
configuration file is located.</p>
|
||
|
<h3 id="general-metadata"><a class="header" href="#general-metadata">General metadata</a></h3>
|
||
|
<p>This is general information about your book.</p>
|
||
|
<ul>
|
||
|
<li><strong>title:</strong> The title of the book</li>
|
||
|
<li><strong>authors:</strong> The author(s) of the book</li>
|
||
|
<li><strong>description:</strong> A description for the book, which is added as meta
|
||
|
information in the html <code><head></code> of each page</li>
|
||
|
<li><strong>src:</strong> By default, the source directory is found in the directory named
|
||
|
<code>src</code> directly under the root folder. But this is configurable with the <code>src</code>
|
||
|
key in the configuration file.</li>
|
||
|
<li><strong>language:</strong> The main language of the book, which is used as a language attribute <code><html lang="en"></code> for example.
|
||
|
This is also used to derive the direction of text (RTL, LTR) within the book.</li>
|
||
|
<li><strong>text-direction</strong>: The direction of text in the book: Left-to-right (LTR) or Right-to-left (RTL). Possible values: <code>ltr</code>, <code>rtl</code>.
|
||
|
When not specified, the text direction is derived from the book's <code>language</code> attribute.</li>
|
||
|
</ul>
|
||
|
<p><strong>book.toml</strong></p>
|
||
|
<pre><code class="language-toml">[book]
|
||
|
title = "Example book"
|
||
|
authors = ["John Doe", "Jane Doe"]
|
||
|
description = "The example book covers examples."
|
||
|
src = "my-src" # the source files will be found in `root/my-src` instead of `root/src`
|
||
|
language = "en"
|
||
|
text-direction = "ltr"
|
||
|
</code></pre>
|
||
|
<h3 id="rust-options"><a class="header" href="#rust-options">Rust options</a></h3>
|
||
|
<p>Options for the Rust language, relevant to running tests and playground
|
||
|
integration.</p>
|
||
|
<pre><code class="language-toml">[rust]
|
||
|
edition = "2015" # the default edition for code blocks
|
||
|
</code></pre>
|
||
|
<ul>
|
||
|
<li>
|
||
|
<p><strong>edition</strong>: Rust edition to use by default for the code snippets. Default
|
||
|
is "2015". Individual code blocks can be controlled with the <code>edition2015</code>,
|
||
|
<code>edition2018</code> or <code>edition2021</code> annotations, such as:</p>
|
||
|
<pre><code class="language-text">```rust,edition2015
|
||
|
// This only works in 2015.
|
||
|
let try = true;
|
||
|
```
|
||
|
</code></pre>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<h3 id="build-options"><a class="header" href="#build-options">Build options</a></h3>
|
||
|
<p>This controls the build process of your book.</p>
|
||
|
<pre><code class="language-toml">[build]
|
||
|
build-dir = "book" # the directory where the output is placed
|
||
|
create-missing = true # whether or not to create missing pages
|
||
|
use-default-preprocessors = true # use the default preprocessors
|
||
|
extra-watch-dirs = [] # directories to watch for triggering builds
|
||
|
</code></pre>
|
||
|
<ul>
|
||
|
<li>
|
||
|
<p><strong>build-dir:</strong> The directory to put the rendered book in. By default this is
|
||
|
<code>book/</code> in the book's root directory.
|
||
|
This can overridden with the <code>--dest-dir</code> CLI option.</p>
|
||
|
</li>
|
||
|
<li>
|
||
|
<p><strong>create-missing:</strong> By default, any missing files specified in <code>SUMMARY.md</code>
|
||
|
will be created when the book is built (i.e. <code>create-missing = true</code>). If this
|
||
|
is <code>false</code> then the build process will instead exit with an error if any files
|
||
|
do not exist.</p>
|
||
|
</li>
|
||
|
<li>
|
||
|
<p><strong>use-default-preprocessors:</strong> Disable the default preprocessors (of <code>links</code> &
|
||
|
<code>index</code>) by setting this option to <code>false</code>.</p>
|
||
|
<p>If you have the same, and/or other preprocessors declared via their table
|
||
|
of configuration, they will run instead.</p>
|
||
|
<ul>
|
||
|
<li>For clarity, with no preprocessor configuration, the default <code>links</code> and
|
||
|
<code>index</code> will run.</li>
|
||
|
<li>Setting <code>use-default-preprocessors = false</code> will disable these
|
||
|
default preprocessors from running.</li>
|
||
|
<li>Adding <code>[preprocessor.links]</code>, for example, will ensure, regardless of
|
||
|
<code>use-default-preprocessors</code> that <code>links</code> it will run.</li>
|
||
|
</ul>
|
||
|
</li>
|
||
|
<li>
|
||
|
<p><strong>extra-watch-dirs</strong>: A list of paths to directories that will be watched in
|
||
|
the <code>watch</code> and <code>serve</code> commands. Changes to files under these directories will
|
||
|
trigger rebuilds. Useful if your book depends on files outside its <code>src</code> directory.</p>
|
||
|
</li>
|
||
|
</ul>
|
||
|
|
||
|
</main>
|
||
|
|
||
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
||
|
<!-- Mobile navigation buttons -->
|
||
|
<a rel="prev" href="../../format/configuration/index.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/configuration/preprocessors.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/configuration/index.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/configuration/preprocessors.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>
|