diff --git a/docs-src/07-latex-output.md b/docs-src/07-latex-output.md index 7357545..d89ad07 100644 --- a/docs-src/07-latex-output.md +++ b/docs-src/07-latex-output.md @@ -34,6 +34,7 @@ The current LaTeX template requires the following packages to be installed: * [graphicx](https://ctan.org/pkg/graphicx) * [float](https://ctan.org/pkg/float) * [svg](https://ctan.org/pkg/svg) +* [menukeys](https://ctan.org/pkg/svg) The template also requires [XeTeX](https://www.tug.org/xetex/) and the following fonts to be available on your system: @@ -43,12 +44,11 @@ The template also requires [XeTeX](https://www.tug.org/xetex/) and the following Finally, in order to color the source code, you must have [Pygments](https://pygments.org/) installed and the `pygmentize` executable must be available on your path. -If you meet all these requirements, you can build the book using `xelatex`. Assuming you built the `book.tex` file in the `print` directory as above: +If you meet all these requirements, you can build the book using `xelatex` (better yet, use `latexmk`). Assuming you built the `book.tex` file in the `print` directory as above: ```sh cd print -xelatex -shell-escape book.tex -xelatex -shell-escape book.tex +latexmk -xelatex -shell-escape book.tex ``` Note that the `-shell-escape` argument is required in order to get _Pygments_ to colour your source code, and the `xelatex` command is run twice in order to properly build the table of contents. diff --git a/docs-src/book.pdf b/docs-src/book.pdf index e949a93..8cc1d62 100644 Binary files a/docs-src/book.pdf and b/docs-src/book.pdf differ diff --git a/docs-src/printbook.pdf b/docs-src/printbook.pdf index cb4aa84..5f69aa5 100644 Binary files a/docs-src/printbook.pdf and b/docs-src/printbook.pdf differ diff --git a/docs/01-command-line.html b/docs/01-command-line.html index 7d1518f..c85078d 100644 --- a/docs/01-command-line.html +++ b/docs/01-command-line.html @@ -12,7 +12,7 @@ - + diff --git a/docs/02-markdown/01-commonmark.html b/docs/02-markdown/01-commonmark.html index 26cfaa7..a3cdc9c 100644 --- a/docs/02-markdown/01-commonmark.html +++ b/docs/02-markdown/01-commonmark.html @@ -12,7 +12,7 @@ - + diff --git a/docs/02-markdown/02-syntax-highlighting.html b/docs/02-markdown/02-syntax-highlighting.html index a226195..7243051 100644 --- a/docs/02-markdown/02-syntax-highlighting.html +++ b/docs/02-markdown/02-syntax-highlighting.html @@ -12,7 +12,7 @@ - + diff --git a/docs/02-markdown/03-plantuml-diagrams.html b/docs/02-markdown/03-plantuml-diagrams.html index d01acb5..fc4184a 100644 --- a/docs/02-markdown/03-plantuml-diagrams.html +++ b/docs/02-markdown/03-plantuml-diagrams.html @@ -12,7 +12,7 @@ - + diff --git a/docs/02-markdown/04-katex-formulas.html b/docs/02-markdown/04-katex-formulas.html index 9a48623..d82d9b0 100644 --- a/docs/02-markdown/04-katex-formulas.html +++ b/docs/02-markdown/04-katex-formulas.html @@ -12,7 +12,7 @@ - + diff --git a/docs/02-markdown/05-images.html b/docs/02-markdown/05-images.html index 5388991..d48bd51 100644 --- a/docs/02-markdown/05-images.html +++ b/docs/02-markdown/05-images.html @@ -12,7 +12,7 @@ - + diff --git a/docs/02-markdown/06-tables.html b/docs/02-markdown/06-tables.html index 734f5cd..606cc20 100644 --- a/docs/02-markdown/06-tables.html +++ b/docs/02-markdown/06-tables.html @@ -12,7 +12,7 @@ - + diff --git a/docs/02-markdown/07-task-lists.html b/docs/02-markdown/07-task-lists.html index c38b42c..92c0202 100644 --- a/docs/02-markdown/07-task-lists.html +++ b/docs/02-markdown/07-task-lists.html @@ -12,7 +12,7 @@ - + diff --git a/docs/02-markdown/08-links.html b/docs/02-markdown/08-links.html index 17b1e7d..476d1a3 100644 --- a/docs/02-markdown/08-links.html +++ b/docs/02-markdown/08-links.html @@ -12,7 +12,7 @@ - + diff --git a/docs/02-markdown/index.html b/docs/02-markdown/index.html index 7741af9..214d43d 100644 --- a/docs/02-markdown/index.html +++ b/docs/02-markdown/index.html @@ -12,7 +12,7 @@ - + diff --git a/docs/03-frontmatter.html b/docs/03-frontmatter.html index ac1a0b7..2ceed1f 100644 --- a/docs/03-frontmatter.html +++ b/docs/03-frontmatter.html @@ -12,7 +12,7 @@ - + diff --git a/docs/04-structure.html b/docs/04-structure.html index 3d42c31..0be3ed1 100644 --- a/docs/04-structure.html +++ b/docs/04-structure.html @@ -12,7 +12,7 @@ - + diff --git a/docs/05-customization.html b/docs/05-customization.html index 6170d5e..a4f6364 100644 --- a/docs/05-customization.html +++ b/docs/05-customization.html @@ -12,7 +12,7 @@ - + diff --git a/docs/06-how-it-works.html b/docs/06-how-it-works.html index 141abd8..2f7a794 100644 --- a/docs/06-how-it-works.html +++ b/docs/06-how-it-works.html @@ -12,7 +12,7 @@ - + diff --git a/docs/07-latex-output.html b/docs/07-latex-output.html index 7ba2481..e0a179e 100644 --- a/docs/07-latex-output.html +++ b/docs/07-latex-output.html @@ -12,7 +12,7 @@ - + @@ -137,6 +137,7 @@
  • graphicx
  • float
  • svg
    • +
  • menukeys

    • The template also requires XeTeX and the following fonts to be available on your system:

    Finally, in order to color the source code, you must have Pygments installed and the pygmentize executable must be available on your path.

    -

    If you meet all these requirements, you can build the book using xelatex. Assuming you built the book.tex file in the print directory as above:

    +

    If you meet all these requirements, you can build the book using xelatex (better yet, use latexmk). Assuming you built the book.tex file in the print directory as above:

     cd print
-xelatex -shell-escape book.tex
-xelatex -shell-escape book.tex
+latexmk -xelatex -shell-escape book.tex

    Note that the -shell-escape argument is required in order to get Pygments to colour your source code, and the xelatex command is run twice in order to properly build the table of contents.

    Note also that in the current template, the pages that are created are 5.5 inches by 8 inches. This is to facilitate booklet printing on North American letter paper. Feel free to change this in the generated book.tex file before compiling if you need to.

    diff --git a/docs/book.pdf b/docs/book.pdf index e949a93..8cc1d62 100644 Binary files a/docs/book.pdf and b/docs/book.pdf differ diff --git a/docs/index.html b/docs/index.html index 4cb5a23..ec63938 100644 --- a/docs/index.html +++ b/docs/index.html @@ -15,14 +15,14 @@ <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> " /> - +

    The mkbook Book

    by Kenton Hamaluik

    - +

    mkbook is my simpler alternative to mdbook 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.

    diff --git a/docs/printbook.pdf b/docs/printbook.pdf index cb4aa84..5f69aa5 100644 Binary files a/docs/printbook.pdf and b/docs/printbook.pdf differ