Skip to content

Latest commit

 

History

History
62 lines (53 loc) · 1.79 KB

how_to_preview_locally.md

File metadata and controls

62 lines (53 loc) · 1.79 KB
Raw

Preview the site locally

Requirements

  • github-pages
  • bundler
  • jekyll

The recommended way of installing these is to use gem, the Ruby package manager.

$ gem install github-pages
$ gem install bundler
$ gem install jekyll

But Ruby version 2.1.0 or higher is required. The version can be checked with

$ ruby -v

The native Ruby on my Mac (Sierra 10.12.6) is 2.0. So I took the following steps to upgrade it.

  1. Open your terminal and run
$ \curl -sSL https://get.rvm.io | bash -s stable

When this is complete, you need to restart your terminal for the rvm to work.

  1. Run
$ rvm install ruby-2.4

Type ruby -v in the terminal, if it is 2.4, you are done.

  1. If it still shows ruby 2.0, run
$ rvm use ruby-2.4

To set this as the default version, run

$ rvm use ruby-2.4 --default

Preview your work using a brower

  1. Navigate into the root directory of the project
  2. Run Jekyll locally
$ bundle exec jekyll serve
Configuration file: /Users/hongzhang/Projects/HandsOnLessons/_config.yml
Configuration file: /Users/hongzhang/Projects/HandsOnLessons/_config.yml
            Source: /Users/hongzhang/Projects/HandsOnLessons
       Destination: /Users/hongzhang/Projects/HandsOnLessons/_site
 Incremental build: disabled. Enable with --incremental
      Generating...
   GitHub Metadata: No GitHub API authentication could be found. Some fields may be missing or have incorrect data.
                    done in 0.582 seconds.
 Auto-regeneration: enabled for '/Users/hongzhang/Projects/HandsOnLessons'
Configuration file: /Users/hongzhang/Projects/HandsOnLessons/_config.yml
    Server address: http://127.0.0.1:4000
  Server running... press ctrl-c to stop.
  1. Open your browser, preview the local site at http://127.0.0.1:4000