Introduce a debug configuration for the documentation website (#6377)

FAForever · Jul 30, 2024 · 4d2cc40 · 4d2cc40
1 parent fafd716
commit 4d2cc40
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 2 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -81,7 +81,7 @@ Assuming [Jekyll] and [Bundler] are installed on your computer:
 
 2.  Run `bundle install`.
 
-3.  Run `bundle exec jekyll serve` to build your site and preview it at `localhost:4000`.
+3.  Run `bundle exec jekyll serve --config _config.yml,_config_debug.ym` to build your site and preview it at `localhost:4000`.
 
     The built site is stored in the directory `_site`.
 

diff --git a/docs/_config_debug.yml b/docs/_config_debug.yml
@@ -0,0 +1,5 @@
+title: FAForever Game Repo [DEBUG MODE]
+
+debug: true
+url: http://127.0.0.1:4000
+baseurl: 
diff --git a/docs/documentation.md b/docs/documentation.md
@@ -27,4 +27,4 @@ In addition we recommend the following tooling:
 To run the documentations website on the localhost you need a command line where the current directory is the `docs` folder. From there you run the following commands:
 
 - `bundle install`: Similar to `npm install` if you're familiar with the Node Package Manager. Should be necessary only once. Installs all relevant packages.
-- `bundle exec jekyll server --incremental`: Once completed the website should be available on your localhost. It runs the website from the `_site` folder. The website is updated automagically on every file change but it is not refreshed automagically. You'll need to refresh the page manually.
+- `bundle exec jekyll serve --config _config.yml,_config_debug.ym`: Once completed the website should be available on your localhost. It runs the website from the `_site` folder. The website is updated automagically on every file change but it is not refreshed automagically. You'll need to refresh the page manually.