ACE3/docs
Fabio Schick 2f9b7002c3
Explosives - Add Cellphone/Detonator Keybinds (#9687)
Co-authored-by: Grim <69561145+LinkIsGrim@users.noreply.github.com>
Co-authored-by: johnb432 <58661205+johnb432@users.noreply.github.com>
2024-02-07 17:47:01 -03:00
..
_includes Documentation - Improve svg handling (#9575) 2023-10-24 14:04:58 +02:00
_layouts Documentation - Improve svg handling (#9575) 2023-10-24 14:04:58 +02:00
_posts replace urls (#8875) 2022-04-14 09:22:23 +02:00
dist Documentation - Improve svg handling (#9575) 2023-10-24 14:04:58 +02:00
img Documentation - Update Wiki AtragMx (#9608) 2024-02-07 07:30:50 -03:00
js Documentation - Improve and move to a modern build system, Fix search not working (#9574) 2023-10-24 11:53:42 +02:00
src Documentation - Improve svg handling (#9575) 2023-10-24 14:04:58 +02:00
tools Tools - Fix header arg types (#9752) 2024-01-22 16:33:30 -06:00
wiki Explosives - Add Cellphone/Detonator Keybinds (#9687) 2024-02-07 17:47:01 -03:00
_config_dev.yml Prepare 3.16.3 Build 79 2024-01-17 09:27:10 -06:00
_config.yml Prepare 3.16.3 Build 79 2024-01-17 09:27:10 -06: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 Documentation - Replace all images by webp equivalents (#8594) 2021-10-24 05:10:30 +02:00
.gitignore Use function documentation script (#6897) 2023-04-30 23:03:35 +02:00
404.md use md extension (#8680) 2021-11-14 07:45:33 +01:00
acebot.json replace urls (#8875) 2022-04-14 09:22:23 +02:00
CNAME Update CNAME 2022-04-14 03:45:17 +02:00
docker-compose.yml run npm audit fix for docs (#6755) 2019-01-02 00:05:28 +01:00
Dockerfile run npm audit fix for docs (#6755) 2019-01-02 00:05:28 +01:00
entrypoint.sh run npm audit fix for docs (#6755) 2019-01-02 00:05:28 +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 Fix docker (#6013) 2018-01-03 20:31:30 +01: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 Documentation - Improve svg handling (#9575) 2023-10-24 14:04:58 +02:00
manifest.json Documentation - Improve svg handling (#9575) 2023-10-24 14:04:58 +02:00
news.md Documentation - Improve svg handling (#9575) 2023-10-24 14:04:58 +02:00
README_DE.md Documentation - Remove badge and link to CircleCI (#9433) 2023-09-25 18:02:54 +02:00
README_PL.md Documentation - Remove badge and link to CircleCI (#9433) 2023-09-25 18:02:54 +02:00
README.md replace urls (#8875) 2022-04-14 09:22:23 +02:00
README.zh-TW.md Documentation - Remove badge and link to CircleCI (#9433) 2023-09-25 18:02:54 +02:00
robots.txt merge gh-pages content into docs folder 2016-08-18 18:37:38 +02:00
sitemap.xml Documentation - Add dependencies page (#8706) 2021-12-02 15:40:46 +01:00
team.md Documentation - Add johnb432 to maintainers (#9604) 2023-10-28 20:49:26 +00:00
version.md use md extension (#8680) 2021-11-14 07:45:33 +01:00

Source of https://ace3.acemod.org/

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