Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/midnightsuyama/asciidoctor-kindle

Asciidoctor extension for converting html to mobi
https://github.com/midnightsuyama/asciidoctor-kindle

asciidoctor

Last synced: about 1 month ago
JSON representation

Asciidoctor extension for converting html to mobi

Awesome Lists containing this project

README

        

# asciidoctor-kindle

[![Build Status](https://travis-ci.org/midnightSuyama/asciidoctor-kindle.svg?branch=master)](https://travis-ci.org/midnightSuyama/asciidoctor-kindle)
[![Gem Version](https://badge.fury.io/rb/asciidoctor-kindle.svg)](http://badge.fury.io/rb/asciidoctor-kindle)

Asciidoctor extension for converting html to mobi

* Fix HTML file (ContentType and StyleType)
* Create TOC file (kindle-toc.html)
* Create OPF file (kindle-package.opf)

## Installation

$ gem install asciidoctor-kindle

## Usage

$ asciidoctor-kindle example.adoc

or

$ asciidoctor -r asciidoctor-kindle example.adoc
$ kindlegen -o kindle-published.mobi kindle-package.opf

## Document Attributes

* `kindle-uid` - unique-identifier in OPF
* `kindle-publisher` - dc:publisher in OPF
* `kindle-cover` - cover-image in OPF

## Development

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](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/midnightSuyama/asciidoctor-kindle.

## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).