README.md

Re:VIEW Scaffold

Scaffold Boilerplate for Re:VIEW and docker-review.

Requirements

• docker

Setup

$ git clone git@github.com:kokuyouwind/review-scaffold.git
$ git remote rm origin
$ git remote add origin (your-repo-url)

option: You can use CircleCI for autobuild pdf and use textlint, reviewdog.

• Setup Your Project
• If you use reviewdog
  • Set REVIEWDOG_GITHUB_API_TOKEN Environment Variable
  • Select "only PullRequest build"
• If you use dropbox upload(master branch only)
  • create access token from Dropbox Developer
  • Set DROPBOX_TOKEN Environment Variable

HowToUse

Run commands at project root.

• ./bin/pdf for create pdf.
  • creates dists/book.pdf
• ./bin/epub for create epub.
  • creates dists/book.epub
• ./bin/html for create html pages.
  • creates docs/*.html
  • GitHub Pages Available
    • set master branch /docs folder for GitHub Pages source
    • ex. https://kokuyouwind.github.io/review-scaffold/
• ./bin/review for check textlint.