Documentation Installation | ACRE2 Documentation

Edit me

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
Open Command Prompt and navigate to this directory
```
  cd <ACRE2_directory>/docs
```
Build and run the container
```
  docker-compose up
```
Navigate to http://localhost:4000

Manually

Windows (CMD)

Install Ruby 2.3.1 (x64)
Install Ruby DevKit for 2.0 and above (x64)
Install NodeJS
Open Command Prompt and navigate to this directory
```
  cd <ACRE2_directory>/docs
```
Install bundler and jekyll gems
```
  gem install bundler jekyll
```
Install required gems through bundler
```
  bundle install
```

Debian / Bash on Ubuntu on Windows

sudo might be required when using below commands.

Open Bash and navigate to this directory
```
  cd <ACRE2_directory>/docs
```
Install make, gcc and nodejs
```
  apt-get install make gcc nodejs
```

Install ruby2.3, rbuy2.3-dev and ruby-switch

  apt-add-repository ppa:brightbox/ruby-ng
  apt-get update
  apt-get install ruby2.3 ruby2.3-dev ruby-switch

Set Ruby version
```
  ruby-switch --set ruby2.3
```
Install bundler and jekyll
```
  gem install bundler jekyll
```
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 --config _config_dev.yml
```
Use --incremental for small changes (not adding/removing files).
Use --force_polling on Bash on Ubuntu on Windows due to a bug preventing watching.
Navigate to http://localhost:4000