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:

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.

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.


Build date: 2022‑11‑01. Copyright 2022, Thomas Weise.