Skip to content

Makimono provides a command line tool to generate an ebook from a set of markdown files.

License

Notifications You must be signed in to change notification settings

fuji-nakahara/makimono

Repository files navigation

Makimono

日本語

Makimono provides a command line tool to generate an ebook from a set of markdown files.

Getting Started

First, install Makimono.

$ gem install makimono

Next, create a Makimono project in the mybook directory.

$ makimono new mybook
$ cd mybook

Write text on a markdown file in the src directory.

$ vi src/01-mybook.md

When you are done writing, create an ebook.

$ makimono build

This will create an EPUB file in out/book.epub.

Example

See https://github.com/topics/makimono-book.

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/makimono. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the 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 Makimono project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

About

Makimono provides a command line tool to generate an ebook from a set of markdown files.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Sponsor this project