mkbook/docs/index.html

<!DOCTYPE html>
<html>
    <head>
        <meta charset="utf-8">
        <meta name="viewport" content="width=device-width, initial-scale=1">
        <title>The mkbook Book</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/" />
        <meta property="og:description" content="&lt;p&gt;&lt;em&gt;mkbook&lt;&#x2f;em&gt; is my simpler alternative to &lt;a href=&quot;https:&#x2f;&#x2f;crates.io&#x2f;crates&#x2f;mdbook&quot;&gt;&lt;em&gt;mdbook&lt;&#x2f;em&gt;&lt;&#x2f;a&gt; which is a great tool, however I really dislike some of the decisions they took—such as relying on javascript for highlighting and navigation and including a lot of bells and whistles such as javascript-based search.&lt;&#x2f;p&gt;
&lt;p&gt;This tool aims to work somewhat similarly to &lt;em&gt;mdbook&lt;&#x2f;em&gt;, but is generally intended to be a more minimal alternative that is customized more towards my needs and desires than anything else.&lt;&#x2f;p&gt;
&lt;p&gt;If you’re not familiar with &lt;em&gt;mdbook&lt;&#x2f;em&gt;, &lt;em&gt;mkbook&lt;&#x2f;em&gt; is a tool to convert a collection of &lt;a href=&quot;https:&#x2f;&#x2f;commonmark.org&#x2f;&quot;&gt;Markdown&lt;&#x2f;a&gt; files into a static website &#x2f; book which can be published online. It was created to help me write documentation with minimum fuss while presenting it in an easy-to-consume manner.&lt;&#x2f;p&gt;
" />
        <meta property="book:author" content="Kenton Hamaluik" />
        <meta property="book:release_date" content="2019-12-20T03:39:13.420786946+00:00" />
        
    </head>
    <body class="toc">
        <header>
            <h1>The mkbook Book</h1>
            <h2>by Kenton Hamaluik</h2>
            <time datetime="2019-12-20T03:39:13.420786946+00:00">Dec 20, 2019</time>
        </header>
        <article>
            <p><em>mkbook</em> is my simpler alternative to <a href="https://crates.io/crates/mdbook"><em>mdbook</em></a> which is a great tool, however I really dislike some of the decisions they took—such as relying on javascript for highlighting and navigation and including a lot of bells and whistles such as javascript-based search.</p>
<p>This tool aims to work somewhat similarly to <em>mdbook</em>, but is generally intended to be a more minimal alternative that is customized more towards my needs and desires than anything else.</p>
<p>If you’re not familiar with <em>mdbook</em>, <em>mkbook</em> is a tool to convert a collection of <a href="https://commonmark.org/">Markdown</a> files into a static website / book which can be published online. It was created to help me write documentation with minimum fuss while presenting it in an easy-to-consume manner.</p>

        </article>
        <nav>
            <h1>Table of Contents</h1>
            <ol>
                
                <li>
                    <a href="01-command-line.html">Command-line Interface</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>
                        
                        <li><a href="02-markdown/03-plantuml-diagrams.html">PlantUML Diagrams</a></li>
                        
                        <li><a href="02-markdown/04-katex-formulas.html">KaTeX (Math) Formulas</a></li>
                        
                        <li><a href="02-markdown/05-images.html">Images</a></li>
                        
                        <li><a href="02-markdown/06-tables.html">Tables</a></li>
                        
                        <li><a href="02-markdown/07-task-lists.html">Task Lists</a></li>
                        
                        <li><a href="02-markdown/08-links.html">Links</a></li>
                        
                    </ol>
                    
                </li>
                
                <li>
                    <a href="03-frontmatter.html">Front Matter</a>
                    
                </li>
                
                <li>
                    <a href="04-structure.html">Structure</a>
                    
                </li>
                
                <li>
                    <a href="05-customization.html">Customization</a>
                    
                </li>
                
                <li>
                    <a href="06-how-it-works.html">How it Works</a>
                    
                </li>
                
                <li>
                    <a href="07-latex-output.html">LaTeX Output</a>
                    
                </li>
                
            </ol>
        </nav>
        <footer><p>&copy; 2019 Kenton Hamaluik</p></footer>
        
    </body>
</html>