{"id":13394909,"url":"https://github.com/kmuto/review","last_synced_at":"2025-05-13T17:11:18.015Z","repository":{"id":782380,"uuid":"474869","full_name":"kmuto/review","owner":"kmuto","description":"Re:VIEW is flexible document format/conversion system","archived":false,"fork":false,"pushed_at":"2025-01-12T02:49:06.000Z","size":44337,"stargazers_count":1354,"open_issues_count":93,"forks_count":215,"subscribers_count":51,"default_branch":"master","last_synced_at":"2025-04-24T01:57:40.132Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://reviewml.org/","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-2.1","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kmuto.png","metadata":{"files":{"readme":"README.md","changelog":"NEWS.ja.md","contributing":null,"funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2010-01-16T12:42:25.000Z","updated_at":"2025-04-21T09:27:10.000Z","dependencies_parsed_at":"2024-01-08T17:13:49.831Z","dependency_job_id":"b66cd2e6-4ba8-432a-9e14-c63d676d5bb0","html_url":"https://github.com/kmuto/review","commit_stats":{"total_commits":3018,"total_committers":66,"mean_commits":45.72727272727273,"dds":0.6192842942345924,"last_synced_commit":"9d1c3e7d0f097496f119ac9b55ff0806781550c8"},"previous_names":[],"tags_count":49,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kmuto%2Freview","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kmuto%2Freview/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kmuto%2Freview/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kmuto%2Freview/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kmuto","download_url":"https://codeload.github.com/kmuto/review/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253990470,"owners_count":21995774,"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-07-30T17:01:35.861Z","updated_at":"2025-05-13T17:11:13.005Z","avatar_url":"https://github.com/kmuto.png","language":"Ruby","readme":"# Re:VIEW\n\n[![Gem Version](https://badge.fury.io/rb/review.svg)](http://badge.fury.io/rb/review)\n[![Build Status](https://github.com/kmuto/review/workflows/Test/badge.svg)](https://github.com/kmuto/review/actions)\n[![Build status](https://ci.appveyor.com/api/projects/status/github/kmuto/review?svg=true)](https://ci.appveyor.com/project/kmuto/review)\n\nRe:VIEW is an easy-to-use digital publishing system for paper books and ebooks.\n\n## Supported Formats\n\n![supported formats](./doc/images/review-generate.png)\n\nOutput formats Re:VIEW supports are:\n\n* EPUB\n* LaTeX\n* InDesign (IDGXML)\n* Markdown\n* plain text (TOPBuilder Text Markup Language)\n\nRe:VIEW uses its original format('Re:VIEW format') as source files.  See doc/format.md.\n\n## Commands\n\nThere are commands generate files directly.\n\n* review-epubmaker: generate EPUB file.\n* review-pdfmaker: generate PDF file using LaTeX (TeXLive).\n* review-textmaker: generate text files.\n* review-webmaker: generate Web pages.\n* review-idgxmlmaker: generate InDesign XML files.\n\nAnd some useful commands.\n\n* review-init: create a project.\n* review-compile: compile Re:VIEW format files.\n* review-vol: figure out size of Re:VIEW files.\n* review-index: generate index with various format.\n* review-preproc: preprocessor.\n* review-epub2html: generate single HTML file from EPUB for CSS typesetting.\n* review-update: update project files.\n\n## Installation\n\nInstall gem yourself as:\n\n    $ gem install review\n\nOr build from source:\n\n    $ git clone https://github.com/kmuto/review.git\n    $ cd review\n    $ rake install\n\nOr add the `./bin` directory to your $PATH:\n\n$ echo \"export PATH=PATH_OF_REVIEW/bin:$PATH\" \u003e\u003e ~/.profile\n\n## Quick Start\n\n```\n$ review-init hello\n$ cd hello\n$ (... add and edit *.re file, config.yml and catalog.yml ...)\n$ rake epub         ## generating EPUB\n$ rake pdf          ## generating PDF (Requirement TeXLive)\n$ rake text         ## generating texts\n$ rake web          ## generating Web pages\n$ rake idgxml       ## generating InDesign XML files\n$ rake vivliostyle  ## generating PDF using Vivliostyle-CLI (Requirement Vivliostyle-CLI)\n```\n\nFor further information, see [doc/quickstart.md](https://github.com/kmuto/review/blob/master/doc/quickstart.md)\n\n## Resources\n\n|         | URL                                         |\n|---------|---------------------------------------------|\n| Home    | http://reviewml.org                         |\n| Project | https://github.com/kmuto/review/            |\n| Gems    | https://rubygems.org/gems/review            |\n| Q\u0026A     | https://github.com/kmuto/review/discussions |\n| Wiki    | https://github.com/kmuto/review/wiki        |\n| Bugs    | https://github.com/kmuto/review/issues      |\n\n### Documents\n\n* Wiki pages: https://github.com/kmuto/review/wiki\n* doc/* files (in English and Japanese)\n\n### Issues tracker\n\n* GitHub: https://github.com/kmuto/review\n\n### Note on Patches/Pull Requests\n\n* Fork the project.\n* Make your feature addition or bug fix.\n* Add tests for it. This is important so I don't break it in a\n  future version unintentionally.\n* Commit, do not mess with rakefile, version, or history.\n  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)\n* Send me a pull request. Bonus points for topic branches.\n\n## License\n\nMain part of Re:VIEW is applied GNU Lesser General Public License (LGPL).\nSee [COPYING](https://github.com/kmuto/review/blob/master/COPYING) file.\n\nException:\n\n* doc/*, samples/*: MIT License. See [LICENSE](https://github.com/kmuto/review/blob/master/doc/LICENSE) file.\n* jumoline.sty, vendor/jumoline: The LaTeX Project Public License. See [LPPL](https://github.com/kmuto/review/blob/master/vendor/jumoline/lppl.txt) file.\n* plistings.sty, vendor/plistings: MIT License. See [LICENSE](https://github.com/kmuto/review/blob/master/vendor/plistings/LICENSE) file.\n* gentombow.sty, vendor/gentombow: BSD License. See [LICENSE](https://github.com/kmuto/review/blob/master/vendor/gentombow/LICENSE) file.\n* jsbook.cls, vendor/jsclasses: BSD License. See [LICENSE](https://github.com/kmuto/review/blob/master/vendor/jsclasses/LICENSE) file.\n\n## Copyright\n\nCopyright (c) 2006-2024 Minero Aoki, Kenshi Muto, Masayoshi Takahashi, Masanori Kado.\n","funding_links":[],"categories":["Ruby","Ebook","Awesome Ruby CLIs"],"sub_categories":["Converting"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkmuto%2Freview","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkmuto%2Freview","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkmuto%2Freview/lists"}