Commit c7bbb46f authored by Russell Dickenson's avatar Russell Dickenson

Merge branch 'page-plain-html-baseurl' into 'master'

Add note about baseurl in Pages

See merge request gitlab-org/gitlab!48352
parents d708c675 c5c5f81b
...@@ -80,6 +80,9 @@ To understand Pages domains clearly, read the examples below. ...@@ -80,6 +80,9 @@ To understand Pages domains clearly, read the examples below.
## URLs and baseurls ## URLs and baseurls
NOTE: **Note:**
The `baseurl` option might be called named differently in some static site generators.
Every Static Site Generator (SSG) default configuration expects Every Static Site Generator (SSG) default configuration expects
to find your website under a (sub)domain (`example.com`), not to find your website under a (sub)domain (`example.com`), not
in a subdirectory of that domain (`example.com/subdir`). Therefore, in a subdirectory of that domain (`example.com/subdir`). Therefore,
...@@ -96,7 +99,7 @@ baseurl: "/blog" ...@@ -96,7 +99,7 @@ baseurl: "/blog"
``` ```
On the contrary, if you deploy your website after forking one of On the contrary, if you deploy your website after forking one of
our [default examples](https://gitlab.com/pages), the baseurl will our [default examples](https://gitlab.com/pages), the `baseurl` will
already be configured this way, as all examples there are project already be configured this way, as all examples there are project
websites. If you decide to make yours a user or group website, you'll websites. If you decide to make yours a user or group website, you'll
have to remove this configuration from your project. For the Jekyll have to remove this configuration from your project. For the Jekyll
...@@ -106,6 +109,9 @@ example we've just mentioned, you'd have to change Jekyll's `_config.yml` to: ...@@ -106,6 +109,9 @@ example we've just mentioned, you'd have to change Jekyll's `_config.yml` to:
baseurl: "" baseurl: ""
``` ```
If you're using the [plain HTML example](https://gitlab.com/pages/plain-html),
you don't need to set a `baseurl`.
## Custom domains ## Custom domains
GitLab Pages supports custom domains and subdomains, served under HTTP or HTTPS. GitLab Pages supports custom domains and subdomains, served under HTTP or HTTPS.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment