2015-07-30 17:59:08 +08:00
|
|
|
<!DOCTYPE HTML>
|
|
|
|
|
<html lang="en">
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="UTF-8">
|
2015-08-03 07:37:13 +08:00
|
|
|
<title>mdBook Documentation</title>
|
2015-07-30 17:59:08 +08:00
|
|
|
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
|
|
|
|
<meta name="description" content="{% block description %}{% endblock %}">
|
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../book.css" media="screen" title="no title" charset="utf-8">
|
|
|
|
|
<link href='http://fonts.googleapis.com/css?family=Open+Sans:300italic,400italic,600italic,700italic,800italic,400,300,600,700,800' rel='stylesheet' type='text/css'>
|
|
|
|
|
<link rel="stylesheet" href="http://maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css">
|
|
|
|
|
</head>
|
|
|
|
|
<body>
|
|
|
|
|
|
|
|
|
|
<div id="sidebar" class="sidebar">
|
2015-08-03 20:23:32 +08:00
|
|
|
<ul class="chapter"><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"class="active"><strong>2.2.</strong> build</a></li></ul><li><strong>3.</strong> Format</li><li><ul class="section"><li><strong>3.1.</strong> SUMMARY.md</li><li><a href="../format/config.html"><strong>3.2.</strong> Configuration</a></li></ul><li><strong>4.</strong> Rust Library</li></ul>
|
2015-07-30 17:59:08 +08:00
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div id="page-wrapper" class="page-wrapper">
|
|
|
|
|
|
2015-08-01 20:12:55 +08:00
|
|
|
<div class="page">
|
2015-08-01 23:21:05 +08:00
|
|
|
<div id="menu-bar" class="menu-bar">
|
|
|
|
|
<i id="sidebar-toggle" class="fa fa-bars left"></i>
|
2015-08-03 07:37:13 +08:00
|
|
|
<h1 class="menu-title">mdBook Documentation</h1>
|
2015-08-01 23:21:05 +08:00
|
|
|
</div>
|
2015-08-04 04:09:26 +08:00
|
|
|
|
2015-08-01 20:12:55 +08:00
|
|
|
<div id="content" class="content">
|
|
|
|
|
<h1>The build command</h1>
|
2015-07-30 17:59:08 +08:00
|
|
|
<p>The build command is used to render your book:</p>
|
|
|
|
|
<pre><code>mdbook build
|
|
|
|
|
</code></pre>
|
|
|
|
|
<p>It will try to parse your <code>SUMMARY.md</code> file to understand the structure of your book
|
|
|
|
|
and fetch the corresponding files.</p>
|
|
|
|
|
<p>The rendered ouput will maintain the same directory structure as the source for
|
|
|
|
|
convenience. Large books will therefore remain structured when rendered.</p>
|
|
|
|
|
<h4>Specify a directory</h4>
|
|
|
|
|
<p>Like init, the build command can take a directory as argument to use instead of the
|
|
|
|
|
current working directory.</p>
|
|
|
|
|
<pre><code>mdbook build path/to/book
|
|
|
|
|
</code></pre>
|
|
|
|
|
<hr />
|
|
|
|
|
<p><strong>note:</strong> make sure to run the build command in the root directory and not in the <code>src</code> directory</p>
|
|
|
|
|
|
2015-08-01 20:12:55 +08:00
|
|
|
</div>
|
2015-07-30 17:59:08 +08:00
|
|
|
</div>
|
|
|
|
|
|
2015-08-01 20:12:55 +08:00
|
|
|
<!--
|
|
|
|
|
Doesn't seem to work: using JavaScript
|
|
|
|
|
alternative until I find a way to do it in the template
|
|
|
|
|
-->
|
2015-08-04 04:09:26 +08:00
|
|
|
|
2015-08-04 18:51:07 +08:00
|
|
|
<a href="../cli/init.html" class="nav-chapters previous">
|
|
|
|
|
<i class="fa fa-angle-left"></i>
|
2015-08-01 20:12:55 +08:00
|
|
|
</a>
|
2015-08-04 04:09:26 +08:00
|
|
|
|
2015-08-01 20:12:55 +08:00
|
|
|
<!-- -->
|
|
|
|
|
|
|
|
|
|
<!-- -->
|
2015-08-04 18:51:07 +08:00
|
|
|
|
2015-08-03 20:23:32 +08:00
|
|
|
<a href="../format/config.html" class="nav-chapters next">
|
2015-08-01 20:12:55 +08:00
|
|
|
<i class="fa fa-angle-right"></i>
|
|
|
|
|
</a>
|
2015-08-04 18:51:07 +08:00
|
|
|
|
2015-08-01 20:12:55 +08:00
|
|
|
<!-- -->
|
|
|
|
|
|
2015-07-30 17:59:08 +08:00
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<script src="http://code.jquery.com/jquery-2.1.4.min.js"></script>
|
|
|
|
|
<script src="../book.js"></script>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
