ACE3/docs
PabstMirror b86ef91d7a
Disable cookoff on RCWS turrets (#5605)
* Disable cookoff on RCWS turrets

* getNumber

* Change config name, add doc
2017-11-30 17:07:46 -06:00
..
_includes [Docs] Update component dependencies 2017-11-17 06:45:43 +01:00
_layouts Add version information to most wiki feature and framework pages (#4303) 2016-08-30 15:49:04 +02:00
_posts add new acerep (#5356) 2017-07-14 18:14:10 +02:00
css fix code block styling 2017-11-02 15:10:14 +01:00
img add new acerep (#5356) 2017-07-14 18:14:10 +02:00
js fix code block styling 2017-11-02 15:10:14 +01:00
src fix code block styling 2017-11-02 15:10:14 +01:00
tools merge gh-pages content into docs folder 2016-08-18 18:37:38 +02:00
wiki Disable cookoff on RCWS turrets (#5605) 2017-11-30 17:07:46 -06:00
_config_dev.yml Prepare release 3.11.0 (build 4) 2017-10-24 15:42:18 +02:00
_config.yml Prepare release 3.11.0 (build 4) 2017-10-24 15:42:18 +02:00
.dockerignore Dockerfile (#4550) 2016-10-16 10:48:14 +02:00
.editorconfig merge gh-pages content into docs folder 2016-08-18 18:37:38 +02:00
.gitattributes merge gh-pages content into docs folder 2016-08-18 18:37:38 +02:00
.gitignore Dockerfile (#4550) 2016-10-16 10:48:14 +02:00
404.html merge gh-pages content into docs folder 2016-08-18 18:37:38 +02:00
CNAME Create CNAME 2016-08-18 19:00:17 +02:00
docker-compose.yml Dockerfile (#4550) 2016-10-16 10:48:14 +02:00
Dockerfile improve dockerfile 2016-11-02 11:49:16 +01:00
favicon-32.png merge gh-pages content into docs folder 2016-08-18 18:37:38 +02:00
favicon.png merge gh-pages content into docs folder 2016-08-18 18:37:38 +02:00
Gemfile merge gh-pages content into docs folder 2016-08-18 18:37:38 +02:00
google38c2ed88459ce9b8.html merge gh-pages content into docs folder 2016-08-18 18:37:38 +02:00
googlebd2887f5a38652f2.html merge gh-pages content into docs folder 2016-08-18 18:37:38 +02:00
humans.txt merge gh-pages content into docs folder 2016-08-18 18:37:38 +02:00
index.html add some rel="noopener" to external links 2016-12-28 08:53:05 +01:00
manifest.json add web app manifest 2016-12-27 09:36:18 +01:00
news.html merge gh-pages content into docs folder 2016-08-18 18:37:38 +02:00
package-lock.json fix code block styling 2017-11-02 15:10:14 +01:00
README_DE.md Prepare release 3.11.0 2017-10-17 20:27:56 +02:00
README_PL.md Prepare release 3.11.0 2017-10-17 20:27:56 +02:00
README.md use https for ace3mod 2016-12-27 09:11:58 +01:00
robots.txt merge gh-pages content into docs folder 2016-08-18 18:37:38 +02:00
sitemap.xml merge gh-pages content into docs folder 2016-08-18 18:37:38 +02:00
team.md fix display error on team page 2017-10-23 15:17:37 +02:00
version.html merge gh-pages content into docs folder 2016-08-18 18:37:38 +02:00

Source of https://ace3mod.com/

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