138 lines
7.3 KiB
HTML
138 lines
7.3 KiB
HTML
|
<!DOCTYPE HTML>
|
||
|
|
<html lang="en">
|
||
|
|
<head>
|
||
|
|
<meta charset="UTF-8">
|
||
|
|
<title>Configuration - mdBook Documentation</title>
|
||
|
|
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
||
|
|
<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">
|
||
|
|
|
||
|
|
<base href="../">
|
||
|
|
|
||
|
|
<link rel="stylesheet" href="book.css">
|
||
|
|
<link href='https://fonts.googleapis.com/css?family=Open+Sans:300italic,400italic,600italic,700italic,800italic,400,300,600,700,800' rel='stylesheet' type='text/css'>
|
||
|
|
|
||
|
|
<link rel="shortcut icon" href="favicon.png">
|
||
|
|
|
||
|
|
<!-- Font Awesome -->
|
||
|
|
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css">
|
||
|
|
|
||
|
|
<link rel="stylesheet" href="highlight.css">
|
||
|
|
<link rel="stylesheet" href="tomorrow-night.css">
|
||
|
|
|
||
|
|
<!-- MathJax -->
|
||
|
|
<script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||
|
|
|
||
|
|
<!-- Fetch JQuery from CDN but have a local fallback -->
|
||
|
|
<script src="https://code.jquery.com/jquery-2.1.4.min.js"></script>
|
||
|
|
<script>
|
||
|
|
if (typeof jQuery == 'undefined') {
|
||
|
|
document.write(unescape("%3Cscript src='jquery.js'%3E%3C/script%3E"));
|
||
|
|
}
|
||
|
|
</script>
|
||
|
|
</head>
|
||
|
|
<body class="light">
|
||
|
|
<!-- Set the theme before any content is loaded, prevents flash -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
var theme = localStorage.getItem('theme');
|
||
|
|
if (theme == null) { theme = 'light'; }
|
||
|
|
$('body').removeClass().addClass(theme);
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<!-- Hide / unhide sidebar before it is displayed -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
var sidebar = localStorage.getItem('sidebar');
|
||
|
|
if (sidebar === "hidden") { $("html").addClass("sidebar-hidden") }
|
||
|
|
else if (sidebar === "visible") { $("html").addClass("sidebar-visible") }
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<div id="sidebar" class="sidebar">
|
||
|
|
<ul class="chapter"><li class="affix"><a href="misc/introduction.html">Introduction</a></li><li><a href="README.html"><strong>1.</strong> mdBook</a></li><li><a href="cli/cli-tool.html"><strong>2.</strong> Command Line Tool</a></li><li><ul class="section"><li><a href="cli/init.html"><strong>2.1.</strong> init</a></li><li><a href="cli/build.html"><strong>2.2.</strong> build</a></li><li><a href="cli/watch.html"><strong>2.3.</strong> watch</a></li><li><a href="cli/serve.html"><strong>2.4.</strong> serve</a></li><li><a href="cli/test.html"><strong>2.5.</strong> test</a></li></ul></li><li><a href="format/format.html"><strong>3.</strong> Format</a></li><li><ul class="section"><li><a href="format/summary.html"><strong>3.1.</strong> SUMMARY.md</a></li><li><a href="format/config.html" class="active"><strong>3.2.</strong> Configuration</a></li><li><a href="format/theme/theme.html"><strong>3.3.</strong> Theme</a></li><li><ul class="section"><li><a href="format/theme/index-hbs.html"><strong>3.3.1.</strong> index.hbs</a></li><li><a href="format/theme/syntax-highlighting.html"><strong>3.3.2.</strong> Syntax highlighting</a></li></ul></li><li><a href="format/mathjax.html"><strong>3.4.</strong> MathJax Support</a></li><li><a href="format/rust.html"><strong>3.5.</strong> Rust code specific features</a></li></ul></li><li><a href="lib/lib.html"><strong>4.</strong> Rust Library</a></li><li class="spacer"></li><li class="affix"><a href="misc/contributors.html">Contributors</a></li></ul>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div id="page-wrapper" class="page-wrapper">
|
||
|
|
|
||
|
|
<div class="page">
|
||
|
|
<div id="menu-bar" class="menu-bar">
|
||
|
|
<div class="left-buttons">
|
||
|
|
<i id="sidebar-toggle" class="fa fa-bars"></i>
|
||
|
|
<i id="theme-toggle" class="fa fa-paint-brush"></i>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<h1 class="menu-title">mdBook Documentation</h1>
|
||
|
|
|
||
|
|
<div class="right-buttons">
|
||
|
|
<i id="print-button" class="fa fa-print" title="Print this book"></i>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div id="content" class="content">
|
||
|
|
<a class="header" href="format\config.html#configuration" id="configuration"><h1>Configuration</h1></a>
|
||
|
|
<p>You can configure the parameters for your book in the <strong><em>book.toml</em></strong> file.</p>
|
||
|
|
<p>We encourage using the TOML format, but JSON is also recognized and parsed.</p>
|
||
|
|
<p>Here is an example of what a <strong><em>book.toml</em></strong> file might look like:</p>
|
||
|
|
<pre><code class="language-toml">title = "Example book"
|
||
|
|
author = "Name"
|
||
|
|
description = "The example book covers examples."
|
||
|
|
dest = "output/my-book"
|
||
|
|
</code></pre>
|
||
|
|
<a class="header" href="format\config.html#supported-variables" id="supported-variables"><h4>Supported variables</h4></a>
|
||
|
|
<p>If relative paths are given, they will be relative to the book's root, i.e. the
|
||
|
|
parent directory of the source directory.</p>
|
||
|
|
<ul>
|
||
|
|
<li><strong>title:</strong> The title of the book.</li>
|
||
|
|
<li><strong>author:</strong> The author of the book.</li>
|
||
|
|
<li><strong>description:</strong> The description, which is added as meta in the html head of each page.</li>
|
||
|
|
<li><strong>src:</strong> The path to the book's source files (chapters in Markdown, SUMMARY.md, etc.). Defaults to <code>root/src</code>.</li>
|
||
|
|
<li><strong>dest:</strong> The path to the directory where you want your book to be rendered. Defaults to <code>root/book</code>.</li>
|
||
|
|
<li><strong>theme_path:</strong> The path to a custom theme directory. Defaults to <code>root/theme</code>.</li>
|
||
|
|
</ul>
|
||
|
|
<p><strong><em>note:</em></strong> <em>the supported configurable parameters are scarce at the moment, but more will be added in the future</em></p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<!-- Mobile navigation buttons -->
|
||
|
|
|
||
|
|
<a href="format/summary.html" class="mobile-nav-chapters previous">
|
||
|
|
<i class="fa fa-angle-left"></i>
|
||
|
|
</a>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<a href="format/theme/theme.html" class="mobile-nav-chapters next">
|
||
|
|
<i class="fa fa-angle-right"></i>
|
||
|
|
</a>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<a href="format/summary.html" class="nav-chapters previous" title="You can navigate through the chapters using the arrow keys">
|
||
|
|
<i class="fa fa-angle-left"></i>
|
||
|
|
</a>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<a href="format/theme/theme.html" class="nav-chapters next" title="You can navigate through the chapters using the arrow keys">
|
||
|
|
<i class="fa fa-angle-right"></i>
|
||
|
|
</a>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- Local fallback for Font Awesome -->
|
||
|
|
<script>
|
||
|
|
if ($(".fa").css("font-family") !== "FontAwesome") {
|
||
|
|
$('<link rel="stylesheet" type="text/css" href="_FontAwesome/css/font-awesome.css">').prependTo('head');
|
||
|
|
}
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<!-- Livereload script (if served using the cli tool) -->
|
||
|
|
|
||
|
|
|
||
|
|
<script src="highlight.js"></script>
|
||
|
|
<script src="book.js"></script>
|
||
|
|
</body>
|
||
|
|
</html>
|