https://github.com/strzibny/asciidoc-book-template

Simple technical book template
https://github.com/strzibny/asciidoc-book-template

Last synced: about 2 months ago
JSON representation

Simple technical book template

• Host: GitHub
• URL: https://github.com/strzibny/asciidoc-book-template
• Owner: strzibny
• License: mit
• Created: 2024-10-24T12:27:02.000Z (3 months ago)
• Default Branch: master
• Last Pushed: 2024-10-24T13:53:54.000Z (3 months ago)
• Last Synced: 2024-10-25T16:50:47.100Z (3 months ago)
• Language: Procfile
• Size: 3.91 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# AsciiDoc Book Template

This is a simple technical book template to publish PDF and ePUB books, used to build books like [Kamal Handbook](https://kamalmanual.com/handbook/) and [Test Driving Rails](https://testdrivingrails.com).

## Features

This template focuses on basic features that are enough to produce a small technical book:

- Cover image

- Code blocks with syntax highlighting

- Images

- Notes

- Tables

## Install

Install Ruby and run `bundle install`:

```bash

$ bundle install

```

## Write

Write your book using [AsciiDoc](https://asciidoc.org) in `book.adoc`. The examples in the repository are tested with PDF and ePUB in mind. Not every feature of AsciiDoc is well supported in all formats.

Create a book cover and saved it as `cover.png`.

## Print

Print your digital book with Foreman:

```bash

$ foreman run print

```

Or print specifically for the format you want:

```bash

$ foreman run pdf

$ foreman run epub

```

The results will show up in `output/`.