Port from Writing With Vim.

Author: panozzaj

.gitignore

@@ -0,0 +1,3 @@
+log.txt
+local-preview.pdf
+_generated

.ruby-gemset

@@ -0,0 +1 @@
+local-leanpub

.ruby-version

@@ -0,0 +1 @@
+default

Book.txt

@@ -0,0 +1,2 @@
+_generated/leanpub/chapter1.markdown
+_generated/leanpub/appendices.markdown

Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+group :development do
+  # book stitching
+  gem 'guard'
+  gem 'guard-process'
+  gem 'rb-inotify', require: false
+  gem 'rb-fsevent', require: false
+  gem 'rb-fchange', require: false
+end

Gemfile.lock

@@ -0,0 +1,36 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.0.8)
+    ffi (1.2.0)
+    guard (1.5.4)
+      listen (>= 0.4.2)
+      lumberjack (>= 1.0.2)
+      pry (>= 0.9.10)
+      thor (>= 0.14.6)
+    guard-process (1.0.1)
+      guard (>= 0.4.2)
+    listen (0.6.0)
+    lumberjack (1.0.2)
+    method_source (0.8.1)
+    pry (0.9.10)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.3.1)
+    rb-fchange (0.0.6)
+      ffi
+    rb-fsevent (0.9.2)
+    rb-inotify (0.8.8)
+      ffi (>= 0.5.0)
+    slop (3.3.3)
+    thor (0.16.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  guard
+  guard-process
+  rb-fchange
+  rb-fsevent
+  rb-inotify

Guardfile

@@ -0,0 +1,15 @@
+# https://github.com/guard/guard#readme
+
+ignore /_generated/
+
+contents_filename = 'contents.txt'
+chapters = File.read(contents_filename).split("\n")
+images = Dir['images/**']
+puts chapters
+files = [*chapters, 'build', *images, contents_filename]
+file_string = files.join("|")
+puts file_string
+
+guard 'process', command: './build' do
+  watch(%r{#{file_string}})
+end

LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2013 Anthony Panozzo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.markdown

@@ -0,0 +1,70 @@
+# Local Leanpub
+
+We don't need to use Leanpub to render our Leanpub book previews. We can do
+that locally using [Pandoc](http://johnmacfarlane.net/pandoc/) and save about
+ninety seconds each time.
+
+This repo is an extraction of some work I did to stitch together a local
+preview of my book on [Writing With Vim](https://leanpub.com/vim-for-writers).
+Here is a way to get your own book previews without the need to send your work
+up to Leanpub every time.
+
+The setup in this repo takes care of some of the work of moving files and
+normalizing differences between Leanpub and Pandoc so that you can easily and
+quickly preview the book contents.
+
+## Local previewing
+
+You need to [have Pandoc installed](http://johnmacfarlane.net/pandoc/installing.html).
+
+At the command-line, run `./build` to generate a PDF locally manually. This
+will look at the contents of contents.txt to generate a `Book.txt` file, which
+is what Leanpub looks at to stitch together your book correctly.
+
+To automate this process, install the Ruby gems locally with `bundle install`.
+Then you can run `bundle exec guard` to automatically regenerate the PDF
+whenever the text contents of the book change or you add or remove a chapter
+from the book. (For my project, I also use `./build` script to correctly
+generate the changes for Leanpub, since I do some post processing to insert
+images, etc.)
+
+Open up the `local-preview.pdf` file to see an approximation of what your book
+will look like when rendered by Leanpub. Many PDF readers have an auto-refresh
+setting, so when your book changes you will see the changes update in the book.
+
+## How book contents are laid out
+
+Leanpub looks at certain files to compile the book in question:
+
+ * `Book.txt` lists all of the chapters of the final book
+ * `Sample.txt` lists the chapters in the sample PDF
+
+We have a file called `contents.txt` that holds the values of things in the book.
+
+My convention is that the book contents are located in `chapter[digit].markdown`
+files. You can always change the scripts if this does not suit you.
+
+## Installing
+
+Clone this repo and put it into your Dropbox folder that Leanpub looks at.
+Then you should be able to run the commands above and see a local preview, and
+publish to Leanpub and have a preview up there.
+
+## Pandoc vs. Leanpub
+
+Leanpub used to use the Pandoc rendering system, but they switched to use their
+own system to have better control over the rendering process. and they support
+many of the same conventions. You should still check your book against
+Leanpub's preview feature before publishing, since there are some differences.
+For example, For example, Leanpub automatically inserts page breaks between chapters
+(depending on your settings) while Pandoc needs the explicit `\\pagebreak`
+command (this repo takes care of this difference.)
+
+## Disclaimer
+
+This project is not affiliated with Leanpub or Pandoc. It just uses Pandoc to
+approximate the preview function of Leanpub.
+
+## License
+
+This code released under the [MIT License](http://en.wikipedia.org/wiki/MIT_License).

Sample.txt

@@ -0,0 +1 @@
+_generated/leanpub/chapter1.markdown

appendices.markdown

@@ -0,0 +1 @@
+# Appendices

build

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+
+require 'fileutils'
+
+chapter_filenames = File.read('contents.txt').split("\n")
+
+base_dir = '_generated'
+leanpub_dir = File.join base_dir, 'leanpub'
+pandoc_dir = File.join base_dir, 'pandoc'
+
+FileUtils.mkdir_p leanpub_dir
+FileUtils.mkdir_p pandoc_dir
+
+# write Book.txt from contents.txt
+# AP: I'm not sure if this is bulletproof if we rename chapters,
+# but let's try this for now
+unless File.read('Book.txt').split("\n").length == chapter_filenames.length
+  File.open('Book.txt', 'w') do |book|
+    chapter_filenames.each do |chapter_filename|
+      book.puts File.join(leanpub_dir, chapter_filename)
+    end
+  end
+end
+
+# copy over files for image insertion
+chapter_filenames.each do |chapter_filename|
+  FileUtils.cp chapter_filename, leanpub_dir
+end
+
+# copy over modified files for futher pandoc processing
+chapter_filenames.each do |chapter_filename|
+  FileUtils.cp File.join(leanpub_dir, chapter_filename), pandoc_dir
+end
+
+# pandoc post-processing
+chapter_filenames.each do |chapter_filename|
+  File.open(File.join(pandoc_dir, chapter_filename), 'a') do |f|
+    f.puts "\nEND OF PANDOC CHAPTER"
+    f.puts "\n\\pagebreak"
+  end
+end
+
+# stitch the current book into a PDF, sending any errors to the ether
+
+File.open("#{base_dir}/Book.txt", 'w') do |book|
+  chapter_filenames.each do |chapter_filename|
+    book.puts File.join(pandoc_dir, chapter_filename)
+  end
+end
+
+`cat #{base_dir}/Book.txt | xargs pandoc \
+  --smart \
+  --table-of-contents \
+  --output=local-preview.pdf`

chapter1.markdown

@@ -0,0 +1 @@
+# Chapter 1

contents.txt

@@ -0,0 +1,2 @@
+chapter1.markdown
+appendices.markdown