From 4d2cc402811fc8f8f288e16d0b260bc0095058c9 Mon Sep 17 00:00:00 2001 From: "(Jip) Willem Wijnia" Date: Tue, 30 Jul 2024 14:24:33 +0200 Subject: [PATCH] Introduce a debug configuration for the documentation website (#6377) --- docs/README.md | 2 +- docs/_config_debug.yml | 5 +++++ docs/documentation.md | 2 +- 3 files changed, 7 insertions(+), 2 deletions(-) create mode 100644 docs/_config_debug.yml diff --git a/docs/README.md b/docs/README.md index 362efd4268..323accaea7 100644 --- 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 new file mode 100644 index 0000000000..967310fa71 --- /dev/null +++ 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 index b542a29118..c6a0a21513 100644 --- 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.