Skip to content

Commit 575dc87

Browse files
committed
chore: update comments for configuration options baseurl and url
Avoid newbies from misusing these two options
1 parent 753cd04 commit 575dc87

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

_config.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,6 @@
33
# Import the theme
44
theme: jekyll-theme-chirpy
55

6-
# Change the following value to '/PROJECT_NAME' ONLY IF your site type is GitHub Pages Project sites
7-
# and doesn't have a custom domain.
8-
baseurl: ""
9-
106
# The language of the webpage › http://www.lingoes.net/en/translator/langcode.htm
117
# If it has the same name as one of the files in folder `_data/locales`, the layout language will also be changed,
128
# otherwise, the layout language will use the default value of 'en'.
@@ -25,7 +21,8 @@ tagline: A text-focused Jekyll theme # it will display as the sub-title
2521
description: >- # used by seo meta and the atom feed
2622
A minimal, responsive and feature-rich Jekyll theme for technical writing.
2723
28-
# fill in the protocol & hostname for your site, e.g., 'https://username.github.io'
24+
# Fill in the protocol & hostname for your site.
25+
# e.g. 'https://username.github.io', note that it does not end with a '/'.
2926
url: ""
3027

3128
github:
@@ -114,6 +111,9 @@ pwa:
114111

115112
paginate: 10
116113

114+
# The base URL of your site
115+
baseurl: ""
116+
117117
# ------------ The following options are not recommended to be modified ------------------
118118

119119
kramdown:

0 commit comments

Comments
 (0)