Minimum Working Example for bookbuilderpy Tool Suite

This is a Minimum Working Example for all the features provided by the bookbuilderpy Tool Suite. You can use this as a blueprint for making your own books.

1. Introduction

The bookbuilderpy Tool Suite generates electronic books from pandoc flavored markdown. It can handle multiple languages of the book at once and also generates a website. Below, you can see the output generated from this example:

English
- book_en.pdf (55 KiB)
  The "portable document format" (pdf) is most suitable for reading on a PC and for printing documents.
- book_en.html (30 KiB)
  A stand-alone web page (html) can be viewed well both on mobile phones as well as on PCs.
- book_en.epub (11 KiB)
  The electronic book format (epub) is convenient for many e-book readers as well as mobile phones.
- book_en.azw3 (20 KiB)
  The Amazon Kindle e-book format (azw3) is a proprietary format suitable for reading on a Kindle device.
- book_en.tar.xz (63 KiB)
  A tar.xz archive containing the book in all the formats mentioned above for convenient download.
- book_en.zip (67 KiB)
  A zip archive containing the book in all the formats mentioned above for convenient download.
Deutsch
- book_de.pdf (57 KiB)
  Das "portable document format" (pdf) ist für das Lesen am PC oder das Ausdrucken geeignet.
- book_de.html (30 KiB)
  Eine stand-alone Webseite (html) kann sowohl auf dem Mobiltelefon als auch auf dem PC gut gelesen werden.
- book_de.epub (11 KiB)
  Das Format für E-Book (epub) ist günstig für E-Book Lesegeräte, Tablets, und Mobiltelefone.
- book_de.azw3 (20 KiB)
  Das Amazon Kindle E-Book Format (azw3) ist proprietär und für Kindles gedacht.
- book_de.tar.xz (65 KiB)
  Ein tar.xz Archiv mit allen oben genannten Formaten des Buchs.
- book_de.zip (70 KiB)
  Ein zip Archiv mit allen oben genannten Formaten des Buchs.
中文
- book_zh.pdf (140 KiB)
  便携式文档格式（pdf）最适合在PC上阅读和打印文档。
- book_zh.html (30 KiB)
  无论是在手机上还是在PC上，都可以很好地查看独立的网页（html）。
- book_zh.epub (11 KiB)
  电子书格式（epub）为许多电子书阅读器和手机提供了便利。
- book_zh.azw3 (21 KiB)
  亚马逊Kindle电子书格式（azw3）是一种适合在Kindle设备上阅读的专有格式。
- book_zh.tar.xz (145 KiB)
  一个tar.xz存档，包含上述所有格式的书籍，便于下载。
- book_zh.zip (150 KiB)
  一个zip存档，包含上述所有格式的书籍，便于下载。

Notice: This README.md file is also used as contents of the automatically generated website.

2. How To Use

If you want to learn more about using the tool suite, you can read the documentation provided in the README.md of its repository.

If you use Ubuntu Linux and have docker installed, then you can run this example on your PC using the docker image holding a complete installation of the tool suite.

mkdir example
cd example
git clone https://github.com/thomasWeise/bookbuilderpy-mwe.git
mkdir result
sudo docker run -v "$(pwd)/bookbuilderpy-mwe":/input/:ro -v "$(pwd)/result":/output/ thomasweise/docker-bookbuilderpy book.md
sudo chown $USER -R result

If you want to create an own book on GitHub and have it automatically compiled and published after each commit, you can use a GitHub Actions for this purpose. This, again, is described in detail in the documentation.

3. License

This example is released under the Attribution-NonCommercial-ShareAlike 4.0 International license (CC BY‑NC‑SA 4.0), see http://creativecommons.org/licenses/by-nc-sa/4.0/ for a summary.

4. Contact

If you have any questions or suggestions, please contact Prof. Dr. Thomas Weise (汤卫思教授) at the Institute of Applied Optimization (应用优化研究所, IAO) of the School of Artificial Intelligence and Big Data (人工智能与大数据学院) of Hefei University (合肥学院), in Hefei, Anhui, China (中国安徽省合肥市) via email to tweise@hfuu.edu.cn with CC to tweise@ustc.edu.cn.