Cool_Tools/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2025-01-10 21:31:49 +01:00
Code Issues Releases Wiki Activity

Updated publish comment on gitlab (#7853)

Browse Source 
* docs(publish gitlab pages): Update publish comment on gitlab

* docs(publish gitlab): Add guide how to disable unique domains

* docs(publish gitlab pages): Solve some styling issues
This commit is contained in:
Niclas Heinz 2024-12-31 09:16:04 +01:00 committed by GitHub
parent 8e4bcb151b
commit 307fceb49f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 17 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/publishing-your-site.md
View File

@ -205,7 +205,23 @@ Now, when a new commit is pushed to the [default branch] (typically `master` or
`main`), the static site is automatically built and deployed. Commit and push
the file to your repository to see the workflow in action.
Your documentation should shortly appear at `<username>.gitlab.io/<repository>`.
Your documentation is not published under `<username>.gitlab.io/<repository>`
by default since **GitLab 17.4** [^1]. However, if you prefer a cleaner URL
structure, such as `<username>.gitlab.io/<repository>`, you need to adjust
your configuration.
To switch from a unique domain to the traditional URL structure, follow
these steps:
1. Locate Your Repository
2. Go to **Settings › Pages** in the repository menu.
3. In the **Unique domain settings** section, **uncheck** the box labeled
4. **Use unique domain**.
5. Click **Save changes** to apply the update.
Now you can reach your documentation under `<username>.gitlab.io/<repository>`.
[^1]: [Release notes for Gitlab 17.4](https://about.gitlab.com/releases/2024/09/19/gitlab-17-4-released/)
## Other