mkbook/docs/06-how-it-works/index.html

<!DOCTYPE html>
<html>
    <head>
        <meta charset="utf-8">
        <meta name="viewport" content="width=device-width, initial-scale=1">
        <title>The mkbook Book | How it Works</title>
        <link rel="stylesheet" href="../style.css" type="text/css" media="all" />
        <link rel="shortcut icon" href="../favicon.ico" />
        <meta property="og:title" content="The mkbook Book" />
        <meta property="og:site_name" content="The mkbook Book" />
        <meta property="og:type" content="book" />
        <meta property="og:url" content="https://hamaluik.github.io/mkbook//06-how-it-works/index.html" />
        
        <meta property="book:author" content="Kenton Hamaluik" />
        <meta property="book:release_date" content="2019-11-29T22:36:42.202445325+00:00" />
    </head>
    <body>
        <nav class="big">
            <header>
                <h1><a href="../index.html">The mkbook Book</a></h1>
                <h2>by Kenton Hamaluik</h2>
            </header>
            <ol>
                
                <li>
                    <a href="../01-introduction/index.html">Introduction</a>
                    
                </li>
                
                <li>
                    <a href="../02-markdown/index.html">Markdown</a>
                    
                    <ol>
                        
                        <li><a href="../02-markdown/01-commonmark.html">CommonMark</a></li>
                        
                        <li><a href="../02-markdown/02-syntax-highlighting.html">Syntax Highlighting</a></li>
                        
                    </ol>
                    
                </li>
                
                <li>
                    <a href="../03-frontmatter/index.html">Front Matter</a>
                    
                </li>
                
                <li>
                    <a href="../04-structure/index.html">Structure</a>
                    
                </li>
                
                <li>
                    <a href="../05-customization/index.html">Customization</a>
                    
                </li>
                
                <li>
                    <a href="../06-how-it-works/index.html" class = "current">How it Works</a>
                    
                </li>
                
            </ol>
        </nav>
        <nav class="small">
            <span>
                <a href="../index.html" alt="Table of Contents">
                    <span class="icon">
                        <svg class="icon-list-ol">
                            <use xlink:href="../icons.svg#icon-list-ol">
                        </svg>
                    </span>
                </a>
                
                    
                    <a href="../05-customization&#x2f;index.html" alt="Customization">
                        <span class="icon">
                            
                            <svg class="icon-arrow-left">
                                <use xlink:href="../icons.svg#icon-arrow-left">
                            </svg>
                            
                        </span>
                    </a>
                
            </span>
            <span class="title">How it Works</span>
            <span>
                <span class="placeholder"></span>
                
                    
                    <span class="placeholder"></span>
                
            </span>
        </nav>
        <article>
            <h1><a href="#how-it-works" aria-hidden="true" class="anchor" id="headerhow-it-works"></a>How it Works</h1>
<p><em>mkbook</em> generates a completely static, javascript-free website from a series of Markdown files. All of the layout and styling is controlled purely by hand-crafted CSS specific to this book’s purpose.</p>
<h2><a href="#assets" aria-hidden="true" class="anchor" id="headerassets"></a>Assets</h2>
<p><em>mkbook</em> currently bundles two assets which get written into the book directory: <code>favicon.ico</code>, and <code>icons.svg</code>. <code>favicon.ico</code> is the <a href="https://fontawesome.com/icons/book?style=solid">Font Awesome 5 book icon</a>, and <code>icons.svg</code> contains 3 <a href="https://fontawesome.com/">Font Awesome 5</a> arrow icons: <a href="https://fontawesome.com/icons/arrow-left?style=solid">arrow-left</a>, <a href="https://fontawesome.com/icons/arrow-right?style=solid">arrow-right</a>, and <a href="https://fontawesome.com/icons/arrow-up?style=solid">arrow-up</a> which are used for navigation. These files are compiled into the <em>mkbook</em> binary using the <a href="https://doc.rust-lang.org/std/macro.include_bytes.html"><code>include_bytes!</code> macro</a>, and written to the output folder on each build.</p>
<h2><a href="#styling" aria-hidden="true" class="anchor" id="headerstyling"></a>Styling</h2>
<p><em>mkbook</em> utilizes <a href="https://sass-lang.com/">Sass</a> to define it’s styles; you can view the sources <a href="https://github.com/hamaluik/mkbook/tree/master/style">on github</a>. In <em>mkbook</em>’s build script, the styles are compiled from their native <code>.scss</code> format into a single, compressed <code>.css</code> file using <a href="https://crates.io/crates/sass-rs">sass-rs</a>. The resulting <code>.css</code> file is then bundled into the binary using the <a href="https://doc.rust-lang.org/std/macro.include_str.html"><code>include_str!</code> macro</a>. When a book is generated, this <code>.css</code> is written to the output folder as <code>style.css</code>, where it is included by each generated <code>.html</code> file.</p>
<h2><a href="#templates" aria-hidden="true" class="anchor" id="headertemplates"></a>Templates</h2>
<p><em>mkbook</em> contains two template files: one for the index, and one for each page / chapter, and uses <a href="https://crates.io/crates/askama">Askama</a> to render the templates. Since the <em>Askama</em> templates are compiled when <em>mkbook</em> is compiled, it is not currently possible to change the templates at run time. You can view the sources for these templates <a href="https://github.com/hamaluik/mkbook/tree/master/templates">on github</a>.</p>
<h2><a href="#markdown-formatting" aria-hidden="true" class="anchor" id="headermarkdown-formatting"></a>Markdown Formatting</h2>
<p>Markdown is formatted usiing <a href="https://crates.io/crates/comrak">comrak</a> with some specific options, see the <a href="02-markdown.html">Markdown chapter</a> for more information.</p>
<h2><a href="#syntax-highlighting" aria-hidden="true" class="anchor" id="headersyntax-highlighting"></a>Syntax Highlighting</h2>
<p>Code is syntax-highlighted using <a href="https://crates.io/crates/syntect">syntect</a> with the default langauges and the <code>base16-eighties</code> colour scheme. Some additional languages above the base list supported by <em>syntect</em> have been aded:</p>
<ul>
<li><code>haxe</code></li>
<li><code>hxml</code></li>
<li><code>sass</code></li>
<li><code>scss</code></li>
<li><code>toml</code></li>
</ul>

            
            
        
        <footer><p>&copy; 2019 Kenton Hamaluik</p></footer>
        </article>
    </body>
</html>
-												added some more chapters and listed supported syntax languages

											
										
										
											5 years ago
+								<!DOCTYPE html>
 								<html>
 								    <head>
 								        <meta charset="utf-8">
 								        <meta name="viewport" content="width=device-width, initial-scale=1">
 								        <title>The mkbook Book | How it Works</title>
-												added sub-chapters

											
										
										
											5 years ago
+								        <link rel="stylesheet" href="../style.css" type="text/css" media="all" />
 								        <link rel="shortcut icon" href="../favicon.ico" />
-												added some more chapters and listed supported syntax languages

											
										
										
											5 years ago
+								        <meta property="og:title" content="The mkbook Book" />
 								        <meta property="og:site_name" content="The mkbook Book" />
 								        <meta property="og:type" content="book" />
-												added sub-chapters

											
										
										
											5 years ago
+								        <meta property="og:url" content="https://hamaluik.github.io/mkbook//06-how-it-works/index.html" />
-												changed mkbook.toml to README.md, updated book to reflect changes

											
										
										
											5 years ago
-												added some more chapters and listed supported syntax languages

											
										
										
											5 years ago
+								        <meta property="book:author" content="Kenton Hamaluik" />
-												changed mkbook.toml to README.md, updated book to reflect changes

											
										
										
											5 years ago
+								        <meta property="book:release_date" content="2019-11-29T22:36:42.202445325+00:00" />
-												added some more chapters and listed supported syntax languages

											
										
										
											5 years ago
+								    </head>
 								    <body>
 								        <nav class="big">
 								            <header>
-												added sub-chapters

											
										
										
											5 years ago
+								                <h1><a href="../index.html">The mkbook Book</a></h1>
-												added some more chapters and listed supported syntax languages

											
										
										
											5 years ago
+								                <h2>by Kenton Hamaluik</h2>
 								            </header>
 								            <ol>
-												added sub-chapters

											
										
										
											5 years ago
+								                <li>
 								                    <a href="../01-introduction/index.html">Introduction</a>
 								                </li>
-												added some more chapters and listed supported syntax languages

											
										
										
											5 years ago
-												added sub-chapters

											
										
										
											5 years ago
+								                <li>
 								                    <a href="../02-markdown/index.html">Markdown</a>
 								                    <ol>
-												changed mkbook.toml to README.md, updated book to reflect changes

											
										
										
											5 years ago
+								                        <li><a href="../02-markdown/01-commonmark.html">CommonMark</a></li>
-												added sub-chapters

											
										
										
											5 years ago
 								                        <li><a href="../02-markdown/02-syntax-highlighting.html">Syntax Highlighting</a></li>
 								                    </ol>
 								                </li>
-												added some more chapters and listed supported syntax languages

											
										
										
											5 years ago
-												added sub-chapters

											
										
										
											5 years ago
+								                <li>
 								                    <a href="../03-frontmatter/index.html">Front Matter</a>
 								                </li>
-												added some more chapters and listed supported syntax languages

											
										
										
											5 years ago
-												added sub-chapters

											
										
										
											5 years ago
+								                <li>
 								                    <a href="../04-structure/index.html">Structure</a>
 								                </li>
-												added some more chapters and listed supported syntax languages

											
										
										
											5 years ago
-												added sub-chapters

											
										
										
											5 years ago
+								                <li>
 								                    <a href="../05-customization/index.html">Customization</a>
 								                </li>
-												added some more chapters and listed supported syntax languages

											
										
										
											5 years ago
-												added sub-chapters

											
										
										
											5 years ago
+								                <li>
 								                    <a href="../06-how-it-works/index.html" class = "current">How it Works</a>
 								                </li>
-												added some more chapters and listed supported syntax languages

											
										
										
											5 years ago
 								            </ol>
 								        </nav>
 								        <nav class="small">
-												added sub-chapters

											
										
										
											5 years ago
+								            <span>
 								                <a href="../index.html" alt="Table of Contents">
-												added some more chapters and listed supported syntax languages

											
										
										
											5 years ago
+								                    <span class="icon">
-												added sub-chapters

											
										
										
											5 years ago
+								                        <svg class="icon-list-ol">
 								                            <use xlink:href="../icons.svg#icon-list-ol">
-												added some more chapters and listed supported syntax languages

											
										
										
											5 years ago
+								                        </svg>
 								                    </span>
 								                </a>
-												added sub-chapters

											
										
										
											5 years ago
 								                    <a href="../05-customization&#x2f;index.html" alt="Customization">
 								                        <span class="icon">
 								                            <svg class="icon-arrow-left">
 								                                <use xlink:href="../icons.svg#icon-arrow-left">
 								                            </svg>
 								                        </span>
 								                    </a>
 								            </span>
 								            <span class="title">How it Works</span>
 								            <span>
-												added some more chapters and listed supported syntax languages

											
										
										
											5 years ago
+								                <span class="placeholder"></span>
-												added sub-chapters

											
										
										
											5 years ago
 								                    <span class="placeholder"></span>
 								            </span>
-												added some more chapters and listed supported syntax languages

											
										
										
											5 years ago
+								        </nav>
 								        <article>
-												changed mkbook.toml to README.md, updated book to reflect changes

											
										
										
											5 years ago
+								            <h1><a href="#how-it-works" aria-hidden="true" class="anchor" id="headerhow-it-works"></a>How it Works</h1>
 								<p><em>mkbook</em> generates a completely static, javascript-free website from a series of Markdown files. All of the layout and styling is controlled purely by hand-crafted CSS specific to this book’s purpose.</p>
-												added some more chapters and listed supported syntax languages

											
										
										
											5 years ago
+								<h2><a href="#assets" aria-hidden="true" class="anchor" id="headerassets"></a>Assets</h2>
 								<p><em>mkbook</em> currently bundles two assets which get written into the book directory: <code>favicon.ico</code>, and <code>icons.svg</code>. <code>favicon.ico</code> is the <a href="https://fontawesome.com/icons/book?style=solid">Font Awesome 5 book icon</a>, and <code>icons.svg</code> contains 3 <a href="https://fontawesome.com/">Font Awesome 5</a> arrow icons: <a href="https://fontawesome.com/icons/arrow-left?style=solid">arrow-left</a>, <a href="https://fontawesome.com/icons/arrow-right?style=solid">arrow-right</a>, and <a href="https://fontawesome.com/icons/arrow-up?style=solid">arrow-up</a> which are used for navigation. These files are compiled into the <em>mkbook</em> binary using the <a href="https://doc.rust-lang.org/std/macro.include_bytes.html"><code>include_bytes!</code> macro</a>, and written to the output folder on each build.</p>
 								<h2><a href="#styling" aria-hidden="true" class="anchor" id="headerstyling"></a>Styling</h2>
 								<p><em>mkbook</em> utilizes <a href="https://sass-lang.com/">Sass</a> to define it’s styles; you can view the sources <a href="https://github.com/hamaluik/mkbook/tree/master/style">on github</a>. In <em>mkbook</em>’s build script, the styles are compiled from their native <code>.scss</code> format into a single, compressed <code>.css</code> file using <a href="https://crates.io/crates/sass-rs">sass-rs</a>. The resulting <code>.css</code> file is then bundled into the binary using the <a href="https://doc.rust-lang.org/std/macro.include_str.html"><code>include_str!</code> macro</a>. When a book is generated, this <code>.css</code> is written to the output folder as <code>style.css</code>, where it is included by each generated <code>.html</code> file.</p>
 								<h2><a href="#templates" aria-hidden="true" class="anchor" id="headertemplates"></a>Templates</h2>
 								<p><em>mkbook</em> contains two template files: one for the index, and one for each page / chapter, and uses <a href="https://crates.io/crates/askama">Askama</a> to render the templates. Since the <em>Askama</em> templates are compiled when <em>mkbook</em> is compiled, it is not currently possible to change the templates at run time. You can view the sources for these templates <a href="https://github.com/hamaluik/mkbook/tree/master/templates">on github</a>.</p>
 								<h2><a href="#markdown-formatting" aria-hidden="true" class="anchor" id="headermarkdown-formatting"></a>Markdown Formatting</h2>
 								<p>Markdown is formatted usiing <a href="https://crates.io/crates/comrak">comrak</a> with some specific options, see the <a href="02-markdown.html">Markdown chapter</a> for more information.</p>
 								<h2><a href="#syntax-highlighting" aria-hidden="true" class="anchor" id="headersyntax-highlighting"></a>Syntax Highlighting</h2>
-												updated docs, changed chapter index.md to README.md

											
										
										
											5 years ago
+								<p>Code is syntax-highlighted using <a href="https://crates.io/crates/syntect">syntect</a> with the default langauges and the <code>base16-eighties</code> colour scheme. Some additional languages above the base list supported by <em>syntect</em> have been aded:</p>
 								<ul>
 								<li><code>haxe</code></li>
 								<li><code>hxml</code></li>
 								<li><code>sass</code></li>
 								<li><code>scss</code></li>
 								<li><code>toml</code></li>
 								</ul>
-												added some more chapters and listed supported syntax languages

											
										
										
											5 years ago
 								        <footer><p>&copy; 2019 Kenton Hamaluik</p></footer>
 								        </article>
 								    </body>
 								</html>