jekyll-build-ebook
Jekyll plugin that adds a subcommand to generate an ebook including your posts.
This gem is built on gepub.
Installation
Add this line to your site's Gemfile:
gem 'jekyll-build-ebook', group: :jekyll_plugins
And then execute:
$ bundle
Usage
You can generate an EPUB file at _ebook/YOUR_SITE_TITLE.epub
by the following command:
$ bundle exec jekyll build-ebook
You can also edit the build settings and the EPUB metadata in _config.yml
:
ebook:
# Build settings
layout: ebook
destination: _ebook
file_name: your-book-title
# EPUB metadata
identifier: http://example.com
title: Your book title
language: ja_JP
creator: Your name
Development
After checking out the repo, run bin/setup
to install dependencies. Then, run rake spec
to run the tests. You can also run bin/console
for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install
. To release a new version, update the version number in version.rb
, and then run bundle exec rake release
, which will create a git tag for the version, push git commits and tags, and push the .gem
file to rubygems.org.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/fuji-nakahara/jekyll-build-ebook. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
License
The gem is available as open source under the terms of the MIT License.
Code of Conduct
Everyone interacting in the JekyllEBook project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.