doc/quickstart.md in review-5.0.0 vs doc/quickstart.md in review-5.1.0

- old
+ new

@@ -7,11 +7,11 @@ Re:VIEW is free software under the terms of the GNU Lesser General Public License Version 2.1, so you can use, modify and redistribute it. This license has no relations with your documents using Re:VIEW, so your documents are not forced to use this license. When you want to distribute Re:VIEW software itself or the system including Re:VIEW software, you should read COPYING file carefully. This article describes how to setup Re:VIEW and use it. -The supported version of the article is Re:VIEW 4.2. +The supported version of the article is Re:VIEW 5.1. ## Set up Re:VIEW Re:VIEW is a software in Ruby and worked in Linux/Unix, macOS, and Windows. You can install Re:VIEW with RubyGems or Git. @@ -159,10 +159,20 @@ $ rake idgxml ## generate InDesign XML ``` There is a sample YAML file [config.yml.sample](https://github.com/kmuto/review/blob/master/doc/config.yml.sample) in the same directory of this document. +#### generate PDF using Vivliostyle CLI + +Instead of using TeX (`review-pdfmaker` or `rake pdf`), you can also create a PDF use [Vivliostyle CLI](https://github.com/vivliostyle/vivliostyle-cli). Re:VIEW creates EPUB first and then converts it to PDF with Vivliostyle CLI. + +```bash +$ rake vivliostyle:build ## build PDF using Viliostyle +$ rake vivliostyle:preview ## preview pages in Chrome/Chromium browser +$ rake vivliostyle ## shortcut of vivliostyle:build +``` + ### add chapters and modify them `catalog.yml` file is a catalog of Re:VIEW format files. If you create new `*.re` files as new chapters, you should add the name of files into `catalog.yml`. @@ -179,10 +189,9 @@ POSTDEF: ``` The first item in CHAPS is the first chapter, and the second item (if you add) is the second chapter. PREDEF is for front matter, APPENDIX is for appendix, and POSTDEF is for back matter. You can see in detail with [catalog.md](https://github.com/kmuto/review/blob/master/doc/catalog.ja.md). - ### more information For more information about Re:VIEW format, see [format.md](https://github.com/kmuto/review/blob/master/doc/format.md).