apocalism-js
Automate your illustrated short story build process
Last updated 5 years ago by andrey-p .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install apocalism-js 
SYNC missed versions from official npm registry.

Apocalism.js

Automate your short story build process

Build Status

What is this?

This is an app I've been working on to compile my illustrated short stories. This is a very early version with a number of problems but I've already used it in production - the results can be seen at http://apocalism.co.uk.

It is essentially a beefed-up opinionated Markdown to HTML to PDF generator with pagination, image management and custom styling capabilities. You supply a Markdown file and high-res images and you get a print-ready PDF, bleeds and everything. You can also build an HTML-only paginated version if you want, too.

apocalism.js built on NodeJS and uses PhantomJS internally to render PDFs.

Who is this for?

It is meant for self publishing writers who:

  • want to work on the content and style of their writing at the same time (but within separate files)
  • want an unobtrusive writing format (Markdown with a few extra bits and bobs)
  • want a styling method that is powerful, popular and easy to pick up (Sass/CSS)
  • want to work in a text editor of their choice
  • are comfortable working with a command line interface

(At least one of those is known to exist at the time of writing.)

Requirements

  • NodeJS (tested on v0.10.22)
  • pdftk
  • graphicsmagick
  • pdfinfo (for local tests only - your distro might have this already)

Installation

npm install -g apocalism-js

Usage

Check out the example in example/. Run the example by doing either make example or, if you've installed using npm -g use apocalism example/example.md.

Loads of useful info in the wiki.

But... why?

I've written up a blog post about how and why I wrote this tool.

Current Tags

  • 0.5.5                                ...           latest (5 years ago)

22 Versions

  • 0.5.5                                ...           5 years ago
  • 0.5.4                                ...           5 years ago
  • 0.5.3                                ...           5 years ago
  • 0.5.2                                ...           5 years ago
  • 0.5.1                                ...           5 years ago
  • 0.5.0                                ...           5 years ago
  • 0.4.4                                ...           6 years ago
  • 0.4.3                                ...           6 years ago
  • 0.4.2                                ...           6 years ago
  • 0.4.1                                ...           6 years ago
  • 0.4.0                                ...           6 years ago
  • 0.3.14                                ...           6 years ago
  • 0.3.13                                ...           6 years ago
  • 0.3.12                                ...           6 years ago
  • 0.3.4                                ...           6 years ago
  • 0.3.11                                ...           6 years ago
  • 0.3.10                                ...           6 years ago
  • 0.3.9                                ...           6 years ago
  • 0.3.8                                ...           6 years ago
  • 0.3.7                                ...           6 years ago
  • 0.3.6                                ...           6 years ago
  • 0.3.5                                ...           6 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 0
Dependencies (15)
Dev Dependencies (7)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |