Skip to content

Files

Latest commit

59ca44b · Jan 11, 2017

History

History
This branch is 4 commits ahead of, 4929 commits behind acemod/ACE3:master.

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Dec 28, 2016
Aug 30, 2016
Dec 27, 2016
Dec 28, 2016
Dec 28, 2016
Dec 28, 2016
Aug 18, 2016
Dec 28, 2016
Aug 18, 2016
Jan 11, 2017
Oct 16, 2016
Aug 18, 2016
Aug 18, 2016
Oct 16, 2016
Aug 18, 2016
Aug 18, 2016
Nov 2, 2016
Aug 18, 2016
Dec 27, 2016
Dec 27, 2016
Dec 27, 2016
Dec 27, 2016
Dec 13, 2016
Oct 16, 2016
Aug 18, 2016
Aug 18, 2016
Aug 18, 2016
Aug 18, 2016
Aug 18, 2016
Dec 28, 2016
Dec 27, 2016
Aug 18, 2016
Aug 18, 2016
Aug 18, 2016
Aug 18, 2016
Aug 18, 2016

Updating compiled JavaScript and CSS files

  • Install Node.js

  • Open Command Prompt and navigate to src directory

    cd <ACE3_directory>/docs/src
    
  • Install Node packages

    npm install
    

    On Bash on Ubuntu on Windows also install nodejs-legacy in case of errors.

  • Update files

    grunt
    

Setting up the Jekyll environment

Using Docker

We include files for Docker to run Jekyll in a separate container. This allows you to not having to install anything apart from Docker on your computer.

Running the Dockerfile

  • Install Docker

  • cd into the /docs/ directory

  • Open Command Prompt and navigate to this directory

    cd <ACE3_directory>/docs
    
  • Build and run the container

    docker-compose up
    
  • Navigate to http://localhost:4000

Manually

Installing prerequisites

Windows (CMD)
  • Install Ruby 2.0.0-p648 (x64)

  • Install Ruby DevKit for 2.0 (x64)

  • Open Command Prompt and navigate to this directory

    cd <ACE3_directory>/docs
    
  • Install bundler gem

    gem install bundler
    
  • Install required gems through bundler

    bundle install
    

Debian / Bash on Ubuntu on Windows

  • Open Bash and navigate to this directory

    cd <ACE3_directory>/docs
    
  • Install make and gcc

    sudo apt-get install make gcc
    
  • Install ruby2.0, ruby2.0-dev and ruby-switch

    sudo apt-add-repository ppa:brightbox/ruby-ng
    sudo apt-get update
    sudo apt-get install ruby2.0 ruby2.0-dev ruby-switch
    
  • Set Ruby version

    sudo ruby-switch --set ruby2.0
    
  • Install bundler

    sudo gem install bundler
    
  • Install required gems through bundler

    bundle install
    
  • In case of sticky folder error during bundle install, execute the following to fix permissions

    find ~/.bundle/cache -type d -exec chmod 0755 {} +
    

Running

  • Run Jekyll through bundler

    bundle exec jekyll serve --future --incremental --config _config_dev.yml
    

    Use --force_polling on Bash on Ubuntu on Windows due to a bug preventing watching.

  • Navigate to http://localhost:4000