2015-08-03 20:23:32 +08:00
<!DOCTYPE HTML>
< html lang = "en" >
< head >
< meta charset = "UTF-8" >
< title > mdBook Documentation< / title >
< 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" >
2015-08-06 00:28:59 +08:00
< link rel = "stylesheet" href = "../highlight.css" media = "screen" title = "no title" charset = "utf-8" >
2015-08-03 20:23:32 +08:00
< / head >
< body >
< div id = "sidebar" class = "sidebar" >
2015-08-06 00:28:59 +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" > < 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" class = "active" > < strong > 3.2.< / strong > Configuration< / a > < / li > < li > < a href = "../format/theme.html" > < strong > 3.3.< / strong > Theme< / a > < / li > < / ul > < li > < strong > 4.< / strong > Rust Library< / li > < / ul >
2015-08-03 20:23:32 +08:00
< / div >
< div id = "page-wrapper" class = "page-wrapper" >
< div class = "page" >
< div id = "menu-bar" class = "menu-bar" >
< i id = "sidebar-toggle" class = "fa fa-bars left" > < / i >
< h1 class = "menu-title" > mdBook Documentation< / h1 >
< / div >
2015-08-04 04:09:26 +08:00
2015-08-03 20:23:32 +08:00
< div id = "content" class = "content" >
< h1 > Configuration< / h1 >
2015-08-06 00:28:59 +08:00
< p > You can configure the parameters for your book in the < em > book.json< / em > file.< / p >
< p > Here is an example of what a < em > book.json< / em > file might look like:< / p >
< pre > < code class = "language-json" > {
2015-08-03 20:23:32 +08:00
" title" : " Example book" ,
" author" : " Name" ,
}
< / code > < / pre >
< h4 > Supported variables< / h4 >
< ul >
< li > < strong > title:< / strong > title of the book< / li >
< li > < strong > author:< / strong > author of the book< / li >
2015-08-06 00:28:59 +08:00
< li > < strong > dest:< / strong > path to the directory where you want your book to be rendered. If a relative path is given it will be relative to the parent directory of the source directory< / li >
2015-08-03 20:23:32 +08:00
< / ul >
< / div >
< / div >
<!--
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/build.html" class = "nav-chapters previous" >
< i class = "fa fa-angle-left" > < / i >
2015-08-03 20:23:32 +08:00
< / a >
2015-08-04 04:09:26 +08:00
2015-08-03 20:23:32 +08:00
<!-- -->
<!-- -->
2015-08-04 18:51:07 +08:00
2015-08-06 00:28:59 +08:00
< a href = "../format/theme.html" class = "nav-chapters next" >
< i class = "fa fa-angle-right" > < / i >
< / a >
2015-08-03 20:23:32 +08:00
<!-- -->
< / div >
< script src = "http://code.jquery.com/jquery-2.1.4.min.js" > < / script >
2015-08-06 00:28:59 +08:00
< script src = "../highlight.js" > < / script >
2015-08-03 20:23:32 +08:00
< script src = "../book.js" > < / script >
< / body >
< / html >
