HaverLab
/
basic-book-builder
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
A Pandoc workflow for building PDF, HTML, EPUB, and LaTeX book format.
46 Commits 1 Branch 6 Tags 33 MiB
JavaScript 99.3%
TeX 0.3%
HTML 0.2%
Go to file
John Haverlack 9db4082835 Roadmap & License Update 2026-02-12 09:01:43 -09:00
.obsidian v1.2.3 2026-02-05 17:36:18 -09:00
build Font Fix 2026-02-12 08:49:58 -09:00
chapters v1.2.3 2026-02-05 17:36:18 -09:00
filters Fixed Code and CLI blocks 2026-02-05 13:01:44 -09:00
lib v1.2.3: MathJax refactor 2026-02-05 16:02:15 -09:00
scripts Font Fix 2026-02-12 08:49:58 -09:00
templates Font Fix 2026-02-12 08:49:58 -09:00
.gitignore v1.1.0 Refactor 2026-02-05 08:53:38 -09:00
LICENSE.md Roadmap & License Update 2026-02-12 09:01:43 -09:00
Makefile Version 1.0.0 Refactor: Fixed Zotero Lib 2026-02-05 11:33:29 -09:00
README.md Roadmap & License Update 2026-02-12 09:01:43 -09:00
metadata.yaml v1.2.3 2026-02-05 17:36:18 -09:00

README.md

basic-book-builder (b3)

Attribute Value
Author John Haverlack
Copyright 2026 John Haverlack
License MIT
Version v1.2.4
Date 2026-02-12

This is a basic book (article) builder template based on a Pandoc build process in conjunction with a number of other tools to generate PDF, DOCX, ODT, HTML, LaTeX, Markdown, and Epub book formats all from a single set of Markdown source content in an Obsidian vault.

Usage

PDF

make pdf

NOTE: Building the PDF also builds the LaTeX version of the book.

HTML

make html

DocX

make docx

NOTE: DocX is a work in progress

ODT

make odt

NOTE: ODT is a work in progress

Other Formats

  • Markdown is a work in progress
  • EPub is a work in progress

Getting Started

Download PDF or HTML version of the b3 book. Which self documents how to use this template:

Clone Repo

git clone https://github.com/jehaverlack/basic-book-builder.git

cd basic-book-builder

Setup Build Environment

NOTE: b3 has only been tested on Debian based systems.

scripts/setup-linux-deb.sh

Testing Build Environment

make all

If this succeeds you have a build environment.

Create a New Project

./scripts/new-project.sh <PATH_TO_PROJECT>

cd <PATH_TO_PROJECT>

Update Config Files:

  1. metadata.yaml
  2. templates/pandoc.yaml
  3. Edit Chapter Content
  4. Build your book

Roadmap

Documentation

  • Zotero Integration

Bugs

  • TBD

Features

  • Windows Build Environment Support
  • Build Workflow Scripts
  • DocX Formatting
  • ODT Formatting