HTML book

A static website template to publish a HTML book

Install

Prepare articles that you want to publish in format of either HTML file or external link.

Warning

If an article is from external link, make sure the site, that you deploy this template to, is whitelisted by anti-hotlinking mechanism if exists.

Tip

Please export articles to HTML from

• Typora *.md files
• Microsoft Word *.docx files
• Jupyter Notebook *.ipynb files

before using this template. The original (editable) files can be kept in the same folder.

Save any articles (if is local files) and attached resources (such as images) to a subfolder of the program's root directory, like example/.

Edit menu.yaml to create the book's meta information and TOC (table of content) of articles.

Name	Data type	Description
title	str	the name of this book
author	str	the author of this book
created_year	str	this book is written in which year
articles	list[article]	list of articles to publish with hierarchical structure

article data format:

Name	Data type	Description
name	str	the title of this article
filepath	str	(optional) relative path of this article (HTML file) inside the program's root directory
sub	list[article]	(optional) (recursive) list of articles to publish with hierarchical structure

Tip

To publish by GitHub Pages, use default settings of GitHub Action -> Static HTML.