135 lines
7.8 KiB
HTML
135 lines
7.8 KiB
HTML
|
<!DOCTYPE HTML>
|
||
|
|
<html lang="en">
|
||
|
|
<head>
|
||
|
|
<meta charset="UTF-8">
|
||
|
|
<title>Theme - 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"><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><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/theme\theme.html#theme" id="theme"><h1>Theme</h1></a>
|
||
|
|
<p>The default renderer uses a <a href="http://handlebarsjs.com/">handlebars</a> template to render your markdown files and comes with a default theme
|
||
|
|
included in the mdBook binary.</p>
|
||
|
|
<p>The theme is totally customizable, you can selectively 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 override
|
||
|
|
and now that file will be used instead of the default file.</p>
|
||
|
|
<p>Here are the files you can override:</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, like hiding / un-hiding the sidebar, changing the theme, ...</li>
|
||
|
|
<li><strong><em>highlight.js</em></strong> is the JavaScript that is used to highlight code snippets, you should not need to modify this.</li>
|
||
|
|
<li><strong><em>highlight.css</em></strong> is the theme used for the code highlighting</li>
|
||
|
|
<li><strong><em>favicon.png</em></strong> the favicon that will be used</li>
|
||
|
|
</ul>
|
||
|
|
<p>Generally, when you want to tweak the theme, you don't need to override all the files. If you only need changes in the stylesheet,
|
||
|
|
there is no point in overriding all the other files. Because custom files take precedence over built-in ones, they will not get updated with new fixes / features.</p>
|
||
|
|
<p><strong>Note:</strong> When you override 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. You can copy the default theme into your source directory automatically by using <code>mdbook init --theme</code> just remove the files you don't want to override.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<!-- Mobile navigation buttons -->
|
||
|
|
|
||
|
|
<a href="format/config.html" class="mobile-nav-chapters previous">
|
||
|
|
<i class="fa fa-angle-left"></i>
|
||
|
|
</a>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<a href="format/theme/index-hbs.html" class="mobile-nav-chapters next">
|
||
|
|
<i class="fa fa-angle-right"></i>
|
||
|
|
</a>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<a href="format/config.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/index-hbs.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>
|