https://github.com/nguyenvanduocit/ebook-template
The Ebook template automatically builds and sends it-self to your Kindle each time a release is created.
https://github.com/nguyenvanduocit/ebook-template
ebook-template epub pandoc-book pandoc-templates
Last synced: 3 months ago
JSON representation
The Ebook template automatically builds and sends it-self to your Kindle each time a release is created.
- Host: GitHub
- URL: https://github.com/nguyenvanduocit/ebook-template
- Owner: nguyenvanduocit
- License: mit
- Created: 2020-11-12T07:26:02.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-05-26T17:01:55.000Z (about 3 years ago)
- Last Synced: 2024-04-16T00:47:00.007Z (about 1 year ago)
- Topics: ebook-template, epub, pandoc-book, pandoc-templates
- Language: CSS
- Homepage:
- Size: 203 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Pandoc book template
> Modified from [pandoc-book-template](https://github.com/wikiti/pandoc-book-template)
## Description
This repository contains a simple template for building [Pandoc](http://pandoc.org/) documents into ebook;
Pandoc is a suite of tools to compile markdown files into EPUB file.
## Usage
### Installing
Please, check [this page](http://pandoc.org/installing.html) for more information.
### Folder structure
Here's a folder structure for a Pandoc book:
```
my-book/ # Root directory.
|- build/ # Folder used to store builded (output) files.
|- chapters/ # Markdowns files; one for each chapter.
|- images/ # Images folder.
| |- cover.png # Cover page for epub.
|- style.css # Css file
|- metadata.yml # Metadata content (title, author...).
```
### Setup generic data
Edit the *metadata.yml* file to set configuration data (note that it must start and end with `---`):
```yml
---
title: My book title
author: Daniel Herzog
rights: MIT License
lang: en-US
tags: [pandoc, book, my-book, etc]
abstract: |
Your summary.
mainfont: DejaVu Sans
# Filter preferences:
# - pandoc-crossref
linkReferences: true
---
```
You can find the list of all available keys on
[this page](http://pandoc.org/MANUAL.html#extension-yaml_metadata_block).
### Creating chapters
Creating a new chapter is as simple as creating a new markdown file in the *chapters/* folder;
you'll end up with something like this:
```
chapters/01-introduction.md
chapters/02-installation.md
chapters/03-usage.md
chapters/04-references.md
```
Pandoc and Make will join them automatically ordered by name; that's why the numeric prefixes are
being used.
All you need to specify for each chapter at least one title:
```md
# Introduction
This is the first paragraph of the introduction chapter.
## First
This is the first subsection.
## Second
This is the second subsection.
```
Each title (*#*) will represent a chapter, while each subtitle (*##*) will represent a chapter's
section. You can use as many levels of sections as markdown supports.
## Export to EPUB
Use this command:
```sh
mkdir -p build
pandoc --toc --toc-depth=2 --webtex --css=style.css --metadata-file=metadata.yml --verbose --wrap=none --epub-cover-image=images/cover.png -o build/epub.epub $(printf '"%s" ' chapters/*.md)
```
or with fishshell
```sh
mkdir -p build
pandoc --toc --toc-depth=2 --webtex --css=style.css --metadata-file=metadata.yml --verbose --wrap=none --epub-cover-image=images/cover.png -o build/epub.epub chapters/*.md
```
The generated file will be placed in *build/epub.epub*.
## Release
Make a tag to release your book.
#### Extra configuration
If you want to configure the output, you'll probably have to look the
[Pandoc Manual](http://pandoc.org/MANUAL.html) for further information about pdf (LaTeX) generation,
custom styles, etc, and modify the Makefile file accordingly.
#### Templates
Output files are generated using [pandoc templates](https://pandoc.org/MANUAL.html#templates). All
templates are located under the `templates/` folder, and may be modified as you will. Some basic
format templates are already included on this repository, ion case you need something to start
with.
## References
- [Pandoc](http://pandoc.org/)
- [Pandoc Manual](http://pandoc.org/MANUAL.html)
- [Wikipedia: Markdown](http://wikipedia.org/wiki/Markdown)
## Action Secrets
Setup for Google SMTP
```
MAIL_USERNAME: [email protected]
MAIL_PASSWORD: your password or app password
MAIL_TO: your_kindle_email@kindle,[email protected]
MAIL_FROM: [email protected]
```
## Contributors
This project has been developed by:
| Avatar | Name | Nickname | Email |
| ------ | ---- | -------- | ----- |
|  | Daniel Herzog | Wikiti | [[email protected]](mailto:[email protected])