74 lines
4.4 KiB
HTML
74 lines
4.4 KiB
HTML
|
<!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">
|
||
|
|
<link rel="stylesheet" href="../../highlight.css" media="screen" title="no title" charset="utf-8">
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
|
||
|
|
<div id="sidebar" class="sidebar">
|
||
|
|
<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><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"class="active"><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><strong>4.</strong> Rust Library</li></ul>
|
||
|
|
</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>
|
||
|
|
|
||
|
|
<div id="content" class="content">
|
||
|
|
<h1>Theme</h1>
|
||
|
|
<p>The default renderer uses a <a href="http://handlebarsjs.com/">handlebars</a> template to render your markdown files in and comes with a default theme
|
||
|
|
included in the mdBook binary.</p>
|
||
|
|
<p>But the theme is totally customizable, you can replace every file from the theme by your own by adding a
|
||
|
|
<code>theme</code> directory in your source folder. Create a new file with the name of the file you want to overwrite
|
||
|
|
and now that file will be used instead of the default file.</p>
|
||
|
|
<p>Here are the files you can overwrite:</p>
|
||
|
|
<ul>
|
||
|
|
<li><strong><em>index.hbs</em></strong> is the handlebars template.</li>
|
||
|
|
<li><strong><em>book.css</em></strong> is the style used in the output. If you want to change the design of your book, this is probably the file you want to modify. Sometimes in conjunction with <code>index.hbs</code> when you want to radically change the layout.</li>
|
||
|
|
<li><strong><em>book.js</em></strong> is mostly used to add client side functionality.</li>
|
||
|
|
</ul>
|
||
|
|
<p><strong>Note:</strong></p>
|
||
|
|
<p>When you overwrite a file, it is possible that you break some functionality. Therefore I recommend to use the file from the default theme as template and only add / modify what you need. In the future you will be able to copy the default theme into your source directory automatically by using <code>mdbook init --theme</code>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<!--
|
||
|
|
Doesn't seem to work: using JavaScript
|
||
|
|
alternative until I find a way to do it in the template
|
||
|
|
-->
|
||
|
|
|
||
|
|
<a href="../../format/config.html" class="nav-chapters previous">
|
||
|
|
<i class="fa fa-angle-left"></i>
|
||
|
|
</a>
|
||
|
|
|
||
|
|
<!-- -->
|
||
|
|
|
||
|
|
<!-- -->
|
||
|
|
|
||
|
|
<a href="../../format/theme/index-hbs.html" class="nav-chapters next">
|
||
|
|
<i class="fa fa-angle-right"></i>
|
||
|
|
</a>
|
||
|
|
|
||
|
|
<!-- -->
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<script src="http://code.jquery.com/jquery-2.1.4.min.js"></script>
|
||
|
|
<script src="../../highlight.js"></script>
|
||
|
|
<script src="../../book.js"></script>
|
||
|
|
</body>
|
||
|
|
</html>
|