Skip to content

Fix missing url configuration option documentation#9699

Merged
jekyllbot merged 6 commits intojekyll:masterfrom
brlin-tw:patch/fix-missing-url-documentation
Oct 20, 2024
Merged

Fix missing url configuration option documentation#9699
jekyllbot merged 6 commits intojekyll:masterfrom
brlin-tw:patch/fix-missing-url-documentation

Conversation

@brlin-tw
Copy link
Copy Markdown
Contributor

This is a 🔦 documentation change.

Summary

This pull request fixes the missing url configuration option documentation, which seems to be a common source of frustration.

It also contains a patch to improve the placeholder value of the baseurl configuration option so that the audience won't confuse the two similar but different configuration options.

Context

Fixes #9698

Currently the `url` configuration option isn't documented in the Build > Configuration > Configuration Options section, this patch adds the missing documentation.

Fixes jekyll#9698.

Signed-off-by: 林博仁(Buo-ren Lin) <buo.ren.lin@gmail.com>
…at it won't be confused with `url`

This patch improves the placeholder value of the `baseurl` configuration option so that it can be understood easier.

Signed-off-by: 林博仁(Buo-ren Lin) <buo.ren.lin@gmail.com>
Signed-off-by: 林博仁(Buo-ren Lin) <buo.ren.lin@gmail.com>
Signed-off-by: 林博仁(Buo-ren Lin) <buo.ren.lin@gmail.com>
…tions data file

Signed-off-by: 林博仁(Buo-ren Lin) <buo.ren.lin@gmail.com>
@ashmaroli
Copy link
Copy Markdown
Member

Thanks @brlin-tw
@jekyllbot: merge +doc

@jekyllbot jekyllbot merged commit 6b0af71 into jekyll:master Oct 20, 2024
jekyllbot added a commit that referenced this pull request Oct 20, 2024
github-actions bot pushed a commit that referenced this pull request Oct 20, 2024
林博仁 Buo-ren Lin: Fix missing `url` configuration option documentation (#9699)

Merge pull request 9699
@brlin-tw brlin-tw deleted the patch/fix-missing-url-documentation branch October 20, 2024 16:48
@jekyll jekyll locked and limited conversation to collaborators Oct 20, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs]: The url build(?) configuration option is not documented in Build > Configuration > Configuration Options

3 participants