Version 1.0.0 Refactor: Fixing PDF Build
This commit is contained in:
parent
db0c58b203
commit
2d8c2c3d18
43
README.md
43
README.md
|
|
@ -1,34 +1,65 @@
|
||||||
# basic-book-builder (b3)
|
# basic-book-builder (b3)
|
||||||
|
|
||||||
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, ODT, HTML, LaTex, Markdown, and Epub book formats from Markdown source content in an Obsidian vault.
|
| Attribute | Value |
|
||||||
|
| --- | --- |
|
||||||
|
| **Author** | John Haverlack |
|
||||||
|
| **Copyright** | 2026 John Haverlack |
|
||||||
|
| **License** | CC BY-ND 4.0 |
|
||||||
|
| **Version** | 1.1.- |
|
||||||
|
| **Date** | 2026-02-04 |
|
||||||
|
|
||||||
|
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
|
## Usage
|
||||||
|
|
||||||
#### PDF
|
#### PDF
|
||||||
|
|
||||||
```
|
```
|
||||||
make pdf
|
make pdf
|
||||||
```
|
```
|
||||||
|
|
||||||
|
> NOTE: Building the PDF also builds the **LaTeX** version of the book.
|
||||||
|
|
||||||
#### HTML
|
#### HTML
|
||||||
|
|
||||||
```
|
```
|
||||||
make html
|
make html
|
||||||
```
|
```
|
||||||
#### LaTex
|
|
||||||
|
#### DocX
|
||||||
|
|
||||||
```
|
```
|
||||||
make latex
|
make docx
|
||||||
```
|
```
|
||||||
#### EPub
|
|
||||||
|
|
||||||
> Note: This configuration still needs work.
|
> NOTE: DocX is a work in progress
|
||||||
|
|
||||||
|
#### ODT
|
||||||
|
|
||||||
```
|
```
|
||||||
make epub
|
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
|
## Getting Started
|
||||||
|
|
||||||
Download PDF or HTML version of the b3 book. Which self documents how to use this template:
|
Download PDF or HTML version of the b3 book. Which self documents how to use this template:
|
||||||
- [basic-book-builder.pdf ](build/basic-book-builder.pdf)
|
- [basic-book-builder.pdf ](build/basic-book-builder.pdf)
|
||||||
- [basic-book-builder.html](build/basic-book-builder.html)
|
- [basic-book-builder.html](build/basic-book-builder.html)
|
||||||
|
|
||||||
|
### Setup Build Environment
|
||||||
|
|
||||||
|
> NOTE: For Debian based systems.
|
||||||
|
|
||||||
|
```
|
||||||
|
scripts/setup-linux-deb.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
# Title
|
# Title
|
||||||
title: "Basic Book Builder"
|
title: "Basic Book Builder"
|
||||||
subtitle: "A Pandoc template for building books and articles"
|
subtitle: "A Pandoc template for building books, documents and articles"
|
||||||
name: "basic-book-builder"
|
name: "basic-book-builder"
|
||||||
logo: "lib/img/UAF-ACEP.png"
|
logo: "lib/img/UAF-ACEP.png"
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue