Coder Social home page Coder Social logo

syedpeer / bookbuilder Goto Github PK

View Code? Open in Web Editor NEW

This project forked from speedshop/bookbuilder

0.0 0.0 0.0 257 KB

A simple template and workflow for publishing books with Pandoc

License: MIT License

Makefile 2.84% Shell 1.04% HTML 10.94% CSS 85.18%

bookbuilder's Introduction

A Simple Book Build Pipeline with Pandoc

This repository is a simple build process for making books with Pandoc. It was used to publish The Complete Guide to Rails Performance and The Ruby on Rails Performance Apocrypha.

This configuration creates PDF, EPUB, TXT, and HTML build artifacts.

Usage

Put contents (I use Markdown, but because it's Pandoc, you can use almost any format for input) inside the /content directory. They will be concatenated in alphabetical order to form the book, so I typically use something like the following structure:

content/00_introduction.md 
content/01_first_chapter.md 
content/02_second_chapter.md
...

h1 and h2 will cause a page break, using the CSS I have in the pandoc folder. I like to have "sub sections" in my books, so I use h1 for the section headers and h2 for chapter headers. h3 and below can be used for emphasis but do not appear in the table of contents.

Images go in the img folder.

The pandoc/epub_metadata.md file is a special place for putting epub-specific metadata.

$ make and $ make clean build and delete the build artifacts, respectively.

$ make wordcount will count the words in the content folder.

bookbuilder's People

Contributors

nateberkopec avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.