126 lines
6.8 KiB
HTML
126 lines
6.8 KiB
HTML
|
<!DOCTYPE HTML>
|
||
|
|
<html lang="en">
|
||
|
|
<head>
|
||
|
|
<meta charset="UTF-8">
|
||
|
|
<title>mdBook - 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" class="active"><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"><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="README.html#mdbook" id="mdbook"><h1>mdBook</h1></a>
|
||
|
|
<p><strong>mdBook</strong> is a command line tool and Rust crate to create books using Markdown files. It's very similar to Gitbook but written in <a href="http://www.rust-lang.org">Rust</a>.</p>
|
||
|
|
<p>What you are reading serves as an example of the output of mdBook and at the same time as high-level docs.</p>
|
||
|
|
<p>mdBook is free and open source, you can find the source code on <a href="https://github.com/azerupi/mdBook">Github</a>. Issues and feature requests can be posted on the <a href="https://github.com/azerupi/mdBook/issues">Github Issue tracker</a>.</p>
|
||
|
|
<a class="header" href="README.html#api-docs" id="api-docs"><h2>API docs</h2></a>
|
||
|
|
<p>Alongside this book you can also read the <a href="mdbook/index.html">API docs</a> generated by Rustdoc if you would like
|
||
|
|
to use mdBook as a crate or write a new renderer and need a more low-level overview.</p>
|
||
|
|
<a class="header" href="README.html#license" id="license"><h2>License</h2></a>
|
||
|
|
<p>mdBook, all the source code, is released under the <a href="https://www.mozilla.org/MPL/2.0/">Mozilla Public License v2.0</a></p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<!-- Mobile navigation buttons -->
|
||
|
|
|
||
|
|
<a href="misc/introduction.html" class="mobile-nav-chapters previous">
|
||
|
|
<i class="fa fa-angle-left"></i>
|
||
|
|
</a>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<a href="cli/cli-tool.html" class="mobile-nav-chapters next">
|
||
|
|
<i class="fa fa-angle-right"></i>
|
||
|
|
</a>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<a href="misc/introduction.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="cli/cli-tool.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>
|