From 6b0af7144d8a24fca647e385ad59ebbdd16c2954 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=9E=97=E5=8D=9A=E4=BB=81=20Buo-ren=20Lin?= Date: Sun, 20 Oct 2024 23:41:58 +0800 Subject: [PATCH] Fix missing `url` configuration option documentation (#9699) Merge pull request 9699 --- docs/_data/config_options/build.yml | 23 ++++++++++++++++++++--- 1 file changed, 20 insertions(+), 3 deletions(-) diff --git a/docs/_data/config_options/build.yml b/docs/_data/config_options/build.yml index 7f63573f..a40f8625 100644 --- a/docs/_data/config_options/build.yml +++ b/docs/_data/config_options/build.yml @@ -112,10 +112,27 @@ flag: --strict_front_matter +- name: Web Domain URL + option: "url: SCHEME://HOST[:PORT]" + description: >- + The canonical URL of the root of your production deploy, composed of the following components:
+    •   Protocol scheme (e.g. http://)
+    •   Hostname or IP address (e.g. example.org)
+    •   (Optional) The port number of the server, prefixed with a colon + (e.g. :8080)
+ The value of this configuration option should NOT have a trailing slash. It will be appended + with the baseurl to form the full URL to your Jekyll site when using the + Liquid filter absolute_url.
+ NOTE: This setting is automatically configured to the localhost URL + when the jekyll serve command is invoked. + + - name: Base URL - description: Serve the website from the given base URL. - option: "baseurl: URL" - flag: -b, --baseurl URL + description: >- + Serve the website from the given base URL (the path between web-server or domain root and your landing + page). + option: "baseurl: /PATH/TO/SITE" + flag: -b, --baseurl /PATH/TO/SITE - name: Trace