Tweaks to the docs + clean-up

book-example/src/README.md

@@ -8,6 +8,11 @@ This book serves as an example of the output of mdBook and as the docs at the sa
 mdBook is free and open source, you can find the source code on [Github](https://github.com/azerupi/mdBook).
 Issues and feature requests can be posted on the [Github Issue tracker](https://github.com/azerupi/mdBook/issues).
 
+## API docs
+
+Alongside this book you can also read the [API docs](mdbook/index.html) generated by Rustdoc if you would like
+to use mdBook as a crate or write a new parser.
+
 ## License
 
 mdBook, all the code and this book, are released under the [Mozilla Public License v2.0](https://www.mozilla.org/MPL/2.0/)

book-example/src/cli/build.md

@@ -23,4 +23,4 @@ mdbook build path/to/book
 
 -------------------
 
-**note:** make sure to run the build command in the root directory and not in the source directory
+***note:*** *make sure to run the build command in the root directory and not in the source directory*

book-example/src/format/config.md

@@ -1,13 +1,14 @@
 # Configuration
 
-You can configure the parameters for your book in the *book.json* file.
+You can configure the parameters for your book in the ***book.json*** file.
 
-Here is an example of what a *book.json* file might look like:
+Here is an example of what a ***book.json*** file might look like:
 
 ```json
 {
     "title": "Example book",
     "author": "Name",
+    "dest": "output/my-book"
 }
 ```
 
@@ -16,3 +17,5 @@ Here is an example of what a *book.json* file might look like:
 - **title:** title of the book
 - **author:** author of the book
 - **dest:** 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
+
+***note:*** *the supported configurable parameters are scarce at the moment, but more will be added in the future*

book-example/src/format/theme/index-hbs.md

@@ -86,5 +86,5 @@ In addition to the properties you can access, there are some handlebars helpers
 
 ------
 
-If you would like me to expose other properties or helpers, please [create a new issue](https://github.com/azerupi/mdBook/issues)
+*If you would like me to expose other properties or helpers, please [create a new issue](https://github.com/azerupi/mdBook/issues)
-and I will consider it.
+and I will consider it.*

book-example/src/format/theme/theme.md

@@ -13,6 +13,4 @@ Here are the files you can overwrite:
 - ***book.css*** 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 `index.hbs` when you want to radically change the layout.
 - ***book.js*** is mostly used to add client side functionality.
 
-**Note:**
+***Note:*** *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 `mdbook init --theme`.*
-
-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 `mdbook init --theme`.

book-example/src/lib/lib.md

@@ -6,9 +6,9 @@ mdBook is not only a command line tool, it can be used as a crate. You can exten
 integrate it in current projects. Here is a short example:
 
 ```rust
-extern crate mdBook;
+extern crate mdbook;
 
-use mdBook::MDBook;
+use mdbook::MDBook;
 use std::path::Path;
 
 fn main() {

src/theme/index.hbs

@@ -31,24 +31,18 @@
                 </div>
             </div>
 
-            <!--
+
-                Doesn't seem to work: {{!#if (previous)}} using JavaScript
-                alternative until I find a way to do it in the template
-            -->
             {{#previous}}
                 <a href="{{link}}" class="nav-chapters previous">
                     <i class="fa fa-angle-left"></i>
                 </a>
             {{/previous}}
-            <!-- {{!/if}} -->
 
-            <!-- {{!#if (next "")}} -->
             {{#next}}
                 <a href="{{link}}" class="nav-chapters next">
                     <i class="fa fa-angle-right"></i>
                 </a>
             {{/next}}
-            <!-- {{!/if}} -->
 
         </div>