Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hayd/leanpub
Build leanpub books locally.
https://github.com/hayd/leanpub
Last synced: about 1 month ago
JSON representation
Build leanpub books locally.
- Host: GitHub
- URL: https://github.com/hayd/leanpub
- Owner: hayd
- License: mit
- Created: 2015-06-02T09:14:05.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2022-08-29T15:38:59.000Z (over 2 years ago)
- Last Synced: 2024-10-31T21:35:39.271Z (about 1 month ago)
- Language: Python
- Size: 10.7 KB
- Stars: 24
- Watchers: 7
- Forks: 6
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- starred-awesome - leanpub - Build leanpub books locally. (Python)
README
# leanpub cli
Build leanpub books locally from the command line.
> Note/Disclaimer: This is not an official Leanpub product, it simply uses
> pandoc to build a pdf from markdown in a similar way to Leanpub. Currently
> the output from leanpub *is different* in style (and this will probably
> always be the case), however I find that it massively speeds up the iteration
> process to be able to build a pdf which looks "similar enough" to Leanpub.
This implements a simple cli for building ebooks locally. Rather than having
upload your new change-set to Dropbox and then trigger leanpub build on
their site - do it all locally.
## Usage
To build the Book (this requires a `Book.txt`):
```sh
$ leanpub book
```
To build the Sample (this requires a `Sample.txt`):
```sh
$ leanpub sample
```
To build both:
```sh
$ leanpub all
```
You can also "watch" for changes in any of the markdown files you are using to
build the book i.e. when a markdown file is saved:
```sh
$ leanpub watch
```
You can get help via the command line with:
```sh
$ leanpub --help
```
## Installation
Install via [pip](https://pip.pypa.io/en/latest/installing.html):
```sh
$ pip install leanpub
```
*Note: if you don't have python installed I recommend
[miniconda](http://conda.pydata.org/miniconda.html); no-admin access required.*
This requires that pandoc is installed, if it's not install it
[here](http://pandoc.org/installing.html).
## Issues / troubleshooting / requests
Please post an [issue on github](https://github.com/hayd/leanpub).
### Going forward
I would like to improve the output to better match leanpub.
Any help it that direction (e.g. css, or prepending the title page) would be
great!