Structure


Let’s create a fresh barebones book project called happy, like so:

$ bookiza new happy --leafs 4 --template comics

Or in shortform:

$ b n happy -l 4 -t comics

Bookiza will bootstrap your project ground up as shown below:

Initializing…  [ manuscript=abba | leafs=4 | template=comics ]
License.txt… :added.
.gitignoring /build /node_modules… :done.
README initialization… :success.
Applying a comics layout… :success.
Mobilizing crust… :success.
Server setup… :completed.
PackageJson configured… :standing by for installation.
Setting bookrc values… :done.
Generating [ 8 ] blank page(s)… : done.

…
…

Installed npm modules… :successfully.

Publish new repo as marvindanig/test? (Y/n) // n to skip.

The project has the following structure:


$ cd test && ls -ltra

README.md         crust             node_modules        trash
assets            gulpfile.js       package-lock.json   .bookrc
build             license.txt       package.json        .gitignore
cover             manuscript        templates           .git

Manuscript

As an author or maker, most of your time creating the book will be spent inside the manuscript folder. Here you’ll see a directory for each page of the book with a number appended to its foldername, like so: page-1, page-2, page-3… and so on until page-2N.

Inside each page directory, you’ll find a file called body.html and style.css. Additionally, you can also add a scripts.js and head.html file inside each page if you need to apply additional components or page specific style on a given page. Bookiza will process and combine all the components of a page and render it on your book.

See how to use preprocessors instead of plain markup and style by altering Bookiza’s mode.

Layout

The templates folder is where all the layout and structure level markup and scripts live. Code and style rules placed inside templates folder get applied across all the pages of a book, so this is an ideal place to choose web-fonts and typography on your book.

Learn more about strong layout templates.

Assets

Assets folder is where all your static assets like images, illustrations or libraries of the book (or comics or magazine) will go. As a convention the assets folder will not hold the Cover and Banner art of your book though.

All resources need to be checked-in and hot-linked via rawgit or an asset hosting provider like Cloudinary (recommended referral link). Using a Content Delivery Network (CDN) to deliver images at right resolution and size dynamically helps your readers get to reading the book faster, especially on high latency networks.

Cover

The cover-art (450px x 610px) for your book and its banner (1400px x 800px) will go into the Cover folder. These images are uploaded via the Cover page of your Superbook on Bubblin.