Code Monkey home page Code Monkey logo

asciidoc-ebook-cjk-boilerplate's Introduction

AsciiDoc eBook Boilerplate for CJK

Synopsis

Boilerplate project to generate eBook with AsciiDoctor toolchain.

System Requirements

Usage

Windows

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-ebook

Migrate the project:

> migrate.bat

Several 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.rb

To compile an EPUB ebook:

> epub.bat

To compile a MOBI ebook:

> mobi.bat

An intermediate EPUB ebook is compiled as well.

To compile a PDF ebook:

> pdf.bat

To compile a PDF ebook for print:

> print.bat

Clean all ebooks:

> clean.bat

Unix

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-ebook

Migrate the project:

$ ./migrate

Several 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.rb

To compile an EPUB ebook:

$ ./epub

To compile a MOBI ebook:

$ ./mobi

An intermediate EPUB ebook is compiled as well.

To compile a PDF ebook:

$ ./pdf

To compile a PDF ebook for print:

$ ./print

Clean all ebooks:

$ ./clean

eBooks with Mixed Chinese and English Text

Sarasa 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.yml

Ebooks with sarasa font look better. Hence, we keep both. It is up to you to choose a font that suits your ebook.

Note

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.

The boilerplate project itself is licensed under MIT.

You keep your own ebooks compiled with the boilerplate in any license you prefer.

asciidoc-ebook-cjk-boilerplate's People

Contributors

opensourcedoc avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.