Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Use Ruby and Gem (https://rubygems.org/) to install Jekyll 

    Info

    How to install Jeklly? https://jekyllrb.com/docs/installation/

    Code Block
    languagebash
    rvm list
    rvm use ruby
    gem install jekyll

    Tips: during installation, error "Could not find a valid gem 'jekyll' (>= 0)..." encountered. To solve it, execute "gem sources --add https://ruby.taobao.org/ --remove https://rubygems.org/" before running "gem install jekyll".


  • Clone Eagle Document Site

    Code Block
    languagebash
    git clone https://github.com/apache/incubator-eagle.git 
    cd incubator-eagle
    git checkout origin/document -b document
  • Build and Preview Eagle Document Site (url is http://127.0.0.1:4000/ by default)

    Code Block
    $ cd website
    $ jekyll serve
    /Users/hao/.rvm/gems/ruby-2.2.0/gems/execjs-2.6.0/lib/execjs/external_runtime.rb:135: warning: Insecure world writable dir /usr/local in PATH, mode 040777
    Configuration file: /Users/hao/Workspace/incubator-eagle/website/_config.yml
                Source: /Users/hao/Workspace/incubator-eagle/website
           Destination: /Users/hao/Workspace/incubator-eagle/website/_site
          Generating...
                        done.
     Auto-regeneration: enabled for '/Users/hao/Workspace/incubator-eagle/website'
    Configuration file: /Users/hao/Workspace/incubator-eagle/website/_config.yml
        Server address: http://127.0.0.1:4000/
      Server running... press ctrl-c to stop.

...