{"id":23284211,"url":"https://github.com/agilecreativity/source2epub","last_synced_at":"2025-04-06T15:15:15.636Z","repository":{"id":19217656,"uuid":"22451773","full_name":"agilecreativity/source2epub","owner":"agilecreativity","description":"Export any git repository (or local project folder) to a single epub file for quick review on your favourite devices.","archived":false,"fork":false,"pushed_at":"2018-03-17T12:49:31.000Z","size":316,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-30T05:01:58.586Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/agilecreativity.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-07-31T01:37:39.000Z","updated_at":"2018-03-17T12:49:23.000Z","dependencies_parsed_at":"2022-09-10T21:51:12.164Z","dependency_job_id":null,"html_url":"https://github.com/agilecreativity/source2epub","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agilecreativity%2Fsource2epub","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agilecreativity%2Fsource2epub/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agilecreativity%2Fsource2epub/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agilecreativity%2Fsource2epub/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/agilecreativity","download_url":"https://codeload.github.com/agilecreativity/source2epub/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247500476,"owners_count":20948880,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-20T01:38:43.622Z","updated_at":"2025-04-06T15:15:15.590Z","avatar_url":"https://github.com/agilecreativity.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"## source2epub\n\n[![Gem Version](https://badge.fury.io/rb/source2epub.svg)][gem]\n[![Dependency Status](https://gemnasium.com/agilecreativity/source2epub.png)][gemnasium]\n[![Code Climate](https://codeclimate.com/github/agilecreativity/source2epub.png)][codeclimate]\n\n[gem]: http://badge.fury.io/rb/source2epub\n[gemnasium]: https://gemnasium.com/agilecreativity/source2epub\n[codeclimate]: https://codeclimate.com/github/agilecreativity/source2epub\n\n- Export/print content of any git repositores (or local project directory) to single epub file for quick review offline.\n\n- Work with [Github][] or [BitBucket][] project or your own git servers\n\n- Thanks to the power of [eeepub gem][] and `:TOhtml` feature of [Vim][].\n\n- Support by your favourite reading devices that support 'epub' format (computer, phone, tablet, etc) that\n\n- Support unlimited color scheme as it is based on output from [Vim][] editor\n\n- Here is the [sample epub file](/samples/source2epub_default_colorscheme.epub) of [source2epub][] produced by `source2epub`\n\n### Related projects\n\n- [source2pdf][] generate the output of the git or local project to a pdf file\n- [code_rippa][] gererate pdf file with the help of LaTeX\n\n### Requirements\n\n- Valid installation of [Vim][] required by [vim_printer][] gem\n\n### Installation\n\n```\ngem install source2epub\n```\n\n### Synopsis/Usage\n\n```\n\nUsage:\n\n  $source2epub -e, --exts=EXT1 EXT2 EXT3 -u, --url=URL -theme=theme_name\n\nExample:\n\n  # Export the *.rb from the given repository\n\n  $source2epub -u https://github.com/agilecreativity/source2epub.git -e rb\n\n  # Export the *.rb and also 'Gemfile' from a local directory 'source2epub'\n  # Note: must be one directory directly above the current directory\n\n  $source2epub -u source2epub -e rb -f Gemfile\n\n  # Export the *.rb and also 'Gemfile' from a given directory 'source2epub'\n  # using 'solarized' theme\n  # Note: 'source2epub' must be exactly one level above current directory\n\n  $source2epub -u source2epub -e rb -f Gemfile -t solarized\n\nOptions:\n\n  -u, --url=URL                   # The full url of the github project to be cloned or local directory name (mandatory)\n                                  # e.g. -u https://github.com/agilecreativity/source2epub\n                                  # Or if used with the project already exist locally\n                                  #      -u source2epub\n\n  -e, --exts=EXT1 EXT2 EXT3 ..    # The list of extension names to be exported (mandatory)\n                                  # e.g. -e md rb\n\n  -f, [--non-exts=one two three]  # The list of file without extension to be exported (optional)\n                                  # e.g. -f Gemfile LICENSE\n\n  -t, [--theme=theme_name]        # The theme to be used with vim_printer see :help :colorscheme from inside Vim\n                                  # default: 'default'\n                                  # e.g. -t solarized\n\n  -p, [--epub-title=title]        # The title of the epub output, if not specified the project_name will be used\n                                  # e.g. -p 'My Cool Project'\n                                  #\n  -s, [--command]                 # Use the input file list from the result of the given shell command\n                                  # Note: the command must return the list of file to be valid\n                                  # e.g. --command 'find . -type f -iname \"*.rb\" | grep -v test | grep -v _spec'\n\nExport a given github URL or local project directory to an epub file\"\n\n```\n\n### Sample Usage:\n\n```shell\nsource2epub -u https://github.com/agilecreativity/source2epub.git -e rb\n```\n\nShould result in something similar to this in the console\n\n```\nFYI: list of extensions: [\"gem\", \"gemspec\", \"lock\", \"md\", \"rb\"]\nFYI: list of all files : [\"./config/initializers/source2epub.rb\", \"./lib/source2epub.rb\", \"./lib/source2epub/cli.rb\", \"./lib/source2epub/configuration.rb\", \"./lib/source2epub/exporter.rb\", \"./lib/source2epub/logger.rb\", \"./lib/source2epub/source2epub.rb\", \"./lib/source2epub/version.rb\", \"./test/lib/source2epub/test_source2epub.rb\", \"./test/test_helper.rb\"]\nFYI: process file 1 of 10 : ./config/initializers/source2epub.rb\nFYI: process file 2 of 10 : ./lib/source2epub.rb\nFYI: process file 3 of 10 : ./lib/source2epub/cli.rb\nFYI: process file 4 of 10 : ./lib/source2epub/configuration.rb\nFYI: process file 5 of 10 : ./lib/source2epub/exporter.rb\nFYI: process file 6 of 10 : ./lib/source2epub/logger.rb\nFYI: process file 7 of 10 : ./lib/source2epub/source2epub.rb\nFYI: process file 8 of 10 : ./lib/source2epub/version.rb\nFYI: process file 9 of 10 : ./test/lib/source2epub/test_source2epub.rb\nFYI: process file 10 of 10 : ./test/test_helper.rb\nYour output file is './source2epub/vim_printer_source2epub.tar.gz'\nYour final output is ./source2epub.epub\n```\n\n### Sample Output\n\n#### Using the 'default' theme/colorscheme for Vim\n\n```shell\nsource2epub -u https://github.com/agilecreativity/code2epub.git --exts rb\n```\n\nWhich generated the following [epub output file](/samples/source2epub_default_colorscheme.epub)\n\nThe example screenshot:\n\n![](/samples/source2epub_default_colorscheme.png)\n\n#### Use non-default colorscheme/theme for Vim\n\nUse my personal favourite [seoul256][] colorscheme\n\n```shell\nsource2epub -u https://github.com/agilecreativity/source2epub.git --exts rb --theme seoul256\n```\n\nWhich generated the following [epub output file](/samples/source2epub_seoul256_colorscheme.epub)\n\nThe example screenshot:\n\n![](/samples/source2epub_seoul256_colorscheme.png)\n\n### Contributing\n\n1. Fork it\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create new Pull Request\n\n[thor]: https://github.com/erikhuda/thor\n[minitest]: https://github.com/seattlerb/minitest\n[yard]: https://github.com/lsegal/yard\n[pry]: https://github.com/pry/pry\n[rubocop]: https://github.com/bbatsov/rubocop\n[grit]: https://github.com/mojombo/grit\n[Ghostscript]: http://todo.com/\n[Wkhtmltopdf]: http://todo.com/\n[Vim]: http://www.vim.org\n[vim_printer]: https://github.com/agilecreativity/vim_printer\n[pdfs2pdf]: https://github.com/agilecreativity/pdfs2pdf\n[html2pdf]: https://github.com/agilecreativity/html2pdf\n[monokai]: https://github.com/lsdr/monokai\n[seoul256]: https://github.com/junegunn/seoul256.vim\n[Github]: http://www.github.com\n[BitBucket]: http://www.bitbucket.org\n[source2pdf]: https://github.com/agilecreativity/source2pdf\n[source2epub]: https://github.com/agilecreativity/source2epub\n[code_rippa]: https://github.com/benjamintanweihao/code_rippa\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagilecreativity%2Fsource2epub","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fagilecreativity%2Fsource2epub","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagilecreativity%2Fsource2epub/lists"}