https://github.com/fedden/ebook_compiler
https://github.com/fedden/ebook_compiler
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/fedden/ebook_compiler
- Owner: fedden
- Created: 2020-04-18T16:45:39.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-04-18T17:38:29.000Z (over 6 years ago)
- Last Synced: 2025-12-12T18:57:23.943Z (7 months ago)
- Language: Python
- Size: 2.93 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Book base template
This repo is a barebones system to build a book from a collecton of markdown files.
### Installation
This is designed for OS X, but could be adapted for other operating systems such as Linux by modifying the `open` call in the `scripts/convert_and_open.sh`. The code requires python3 to be installed system wide.
In addition, both `xelatex`, `pandoc` and `pandoc-citeproc` are required to build the book. E.g for OS X:
```bash
brew install pandoc pandoc-citeproc
```
Finall, the tool `fswatch` [will also need to be installed.](https://github.com/emcrisostomo/fswatch)
### Usage
The idea is to write chapters as seperate markdown files. Each chapter should have the number in the file name, e.g for chapter one, for a book name called `book_name`, we'd store the file as `./book_name/chapter_name_1.md`. Additionally store references in a single `.bib` file in the `./book_name`.
To build the book any time a markdown file is modified, please run `./scripts/watch book_name`. This will watch for the changes and rebuild the book as `book_name.pdf` in the `output` directory.
### Accreditation
[This is all based on this excellent blog post.](https://keleshev.com/my-book-writing-setup/)