A minimal yet powerful boilerplate for generating clean, multi-format eBooks (EPUB, MOBI, PDF, print) using the AsciiDoctor toolchain — with full support for Chinese, Japanese, and Korean (CJK) text.
This project provides:
-
Clean separation of content and layout
-
Automatic project scaffolding and theming
-
Unicode-friendly font presets for East Asian mixed-language typesetting
-
Support for EPUB, MOBI, and PDF output with a unified build process
Whether you’re writing technical guides, translated texts, or bilingual books, this boilerplate helps you get started quickly — without having to reinvent the toolchain.
Clone the project locally and change your working directory accordingly:
> git clone https://github.com/opensourcedoc/asciidoc-ebook-cjk-boilerplate.git my-ebook
> cd my-ebookMigrate the project:
> migrate.batSeveral files are generated. Keep the template files as is.
Modify parameters.yml as needed. Migrate the parameters of the ebook in the project:
> ruby migrate.rbTo compile an EPUB ebook:
> epub.batTo compile a MOBI ebook:
> mobi.batAn intermediate EPUB ebook is compiled as well.
To compile a PDF ebook:
> pdf.batTo compile a PDF ebook for print:
> print.batClean all ebooks:
> clean.batClone the project locally and change your working directory accordingly:
$ git clone https://github.com/opensourcedoc/asciidoc-ebook-cjk-boilerplate.git my-ebook
$ cd my-ebookMigrate the project:
$ ./migrateSeveral files are generated. Keep the template files as is.
Modify parameters.yml as needed. Migrate the parameters of the ebook in the project:
$ ruby migrate.rbTo compile an EPUB ebook:
$ ./epubTo compile a MOBI ebook:
$ ./mobiAn intermediate EPUB ebook is compiled as well.
To compile a PDF ebook:
$ ./pdfTo compile a PDF ebook for print:
$ ./printClean all ebooks:
$ ./cleanSarasa gothic TC font doesn’t support ebooks with mixed Chinese and English text well. Ebooks with sarasa font will be rendered with incorrect line wrapping sometimes.
If you are writing an ebook with mixed Chinese and English, use WenQuanYi Zen Hei instead.
Migrate the CJK theme:
$ cp cjk-wqy-theme.yml cjk-theme.ymlEbooks with sarasa font look better. Hence, we keep both. It is up to you to choose a font that suits your ebook.
You have to edit epub.adoc, pdf.adoc and print.adoc separately to generate ebooks of different file formats, which is the limitation imposed by AsciiDoctor toolchain currently.