Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance option's case for Jekyll configuration #8992

Merged
merged 1 commit into from
Mar 11, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/_data/config_options/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
flag: --lsi


- name: Limit Posts
- name: Limit posts
description: Limit the number of posts to parse and publish.
option: "limit_posts: NUM"
flag: --limit_posts NUM
Expand All @@ -72,12 +72,12 @@
flag: -V, --verbose


- name: Silence Output
- name: Silence output
description: Silence the normal output from Jekyll during a build.
flag: -q, --quiet


- name: Log Level
- name: Log level
description: Specify a log level among debug, info, warn, or error.
flag: JEKYLL_LOG_LEVEL=info

Expand All @@ -93,7 +93,7 @@
flag: -I, --incremental


- name: Disable Bundle Require
- name: Disable bundle require
description: Disables the need to require gems in `:jekyll_plugins` Gemfile
flag: JEKYLL_NO_BUNDLER_REQUIRE=true

Expand All @@ -104,7 +104,7 @@
flag: --profile


- name: Strict Front Matter
- name: Strict front matter
description: Cause a build to fail if there is a YAML syntax error in a page's front matter.
option: "strict_front_matter: BOOL"
flag: --strict_front_matter
Expand Down
8 changes: 4 additions & 4 deletions docs/_data/config_options/global.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
- name: Site Source
- name: Site source
description: Change the directory where Jekyll will read files
option: "source: DIR"
flag: -s, --source DIR


- name: Site Destination
- name: Site destination
description: Change the directory where Jekyll will write files
option: "destination: DIR"
flag: -d, --destination DIR
Expand All @@ -17,7 +17,7 @@
flag: --safe


- name: Disable Disk Cache
- name: Disable disk cache
version-badge: 4.1.0
description: >-
Disable caching of content to disk in order to skip creating a <code>.jekyll-cache</code> or similar directory at
Expand Down Expand Up @@ -57,7 +57,7 @@
option: "keep_files: [DIR, FILE, ...]"


- name: Time Zone
- name: Time zone
description: >-
Set the time zone for site generation. This sets the <code>TZ</code> environment variable, which Ruby uses to handle
time and date creation and manipulation. Any entry from the
Expand Down
18 changes: 9 additions & 9 deletions docs/_data/config_options/serve.yml
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
- name: Local Server Port
- name: Local server port
description: Listen on the given port. The default is `4000`.
option: "port: PORT"
flag: "-P, --port PORT"


- name: Local Server Hostname
- name: Local server hostname
description: Listen at the given hostname. The default is `localhost`.
option: "host: HOSTNAME"
flag: "-H, --host HOSTNAME"


- name: Live Reload
- name: Live reload
description: Reload a page automatically on the browser when its content is edited.
option: "livereload: BOOL"
flag: "-l, --livereload"


- name: Live Reload Ignore
- name: Live reload ignore
description: File glob patterns for LiveReload to ignore.
option: "livereload_ignore: [ GLOB1,... ]"
flag: "--livereload-ignore GLOB1[,GLOB2,...]"


- name: Live Reload Min/Max Delay
- name: Live reload min/max delay
description: Minimum/Maximum delay before automatically reloading page.
options:
- "livereload_min_delay: SECONDS"
Expand All @@ -32,7 +32,7 @@
- "--livereload-max-delay SECONDS"


- name: Live Reload Port
- name: Live reload port
description: Port for LiveReload to listen on.
flag: "--livereload-port PORT"

Expand All @@ -55,17 +55,17 @@
flag: "--skip-initial-build"


- name: Show Directory Listing
- name: Show directory listing
description: Show a directory listing instead of loading your index file.
option: "show_dir_listing: BOOL"
flag: "--show-dir-listing"


- name: X.509 (SSL) Private Key
- name: X.509 (SSL) private key
description: "SSL Private Key, stored or symlinked in the site source."
flag: "--ssl-key"


- name: X.509 (SSL) Certificate
- name: X.509 (SSL) certificate
description: "SSL Public certificate, stored or symlinked in the site source."
flag: "--ssl-cert"