Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
M
mkdocs-test
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Raphaël Schröter
mkdocs-test
Commits
7afa8331
Commit
7afa8331
authored
1 year ago
by
pablo_import
Browse files
Options
Downloads
Patches
Plain Diff
Update README
parent
7c7f4a24
Branches
Branches containing commit
Tags
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+4
-64
4 additions, 64 deletions
README.md
with
4 additions
and
64 deletions
README.md
+
4
−
64
View file @
7afa8331


---
---
Example
[MkDocs] website using GitLab Pages.
[MkDocs] website using GitLab Pages.
Learn more about GitLab Pages at https://pages.gitlab.io and the official
Learn more about GitLab Pages at https://pages.gitlab.io and the official
documentation https://docs.gitlab.com/ce/user/project/pages/.
documentation https://docs.gitlab.com/ce/user/project/pages/.
---
---
## GitLab CI
This project's static Pages are built by
[
GitLab CI
][
ci
]
, following the steps
defined in
[
`.gitlab-ci.yml`
](
.gitlab-ci.yml
)
:
```
image: python:3.8-buster
before_script:
- pip install -r requirements.txt
test:
stage: test
script:
- mkdocs build --strict --verbose --site-dir test
artifacts:
paths:
- test
rules:
- if: $CI_COMMIT_REF_NAME != $CI_DEFAULT_BRANCH
pages:
stage: deploy
script:
- mkdocs build --strict --verbose
artifacts:
paths:
- public
rules:
- if: $CI_COMMIT_REF_NAME == $CI_DEFAULT_BRANCH
```
## Building locally
## Building locally
To work locally with this project, you'll have to follow the steps below:
To work locally with this project, you'll have to follow the steps below:
...
@@ -54,39 +22,11 @@ To work locally with this project, you'll have to follow the steps below:
...
@@ -54,39 +22,11 @@ To work locally with this project, you'll have to follow the steps below:
Read more at MkDocs
[
documentation
][]
.
Read more at MkDocs
[
documentation
][]
.
## GitLab User or Group Pages
To use this project as your user/group website, you will need one additional
step: just rename your project to
`namespace.gitlab.io`
, where
`namespace`
is
your
`username`
or
`groupname`
. This can be done by navigating to your
project's
**Settings**
.
You'll need to configure your site too: change the
`site_url`
line
in your
`mkdocs.yml`
, from
`"https://pages.gitlab.io/mkdocs/"`
to
`site_url: "https://namespace.gitlab.io"`
.
Read more about
[
user/group Pages
][
userpages
]
and
[
project Pages
][
projpages
]
.
## Did you fork this project?
If you forked this project for your own use, please go to your project's
**Settings**
and remove the forking relationship, which won't be necessary
unless you want to contribute back to the upstream project.
## Troubleshooting
1.
CSS is missing! That means two things:
Either that you have wrongly set up the CSS URL in your templates, or
your static generator has a configuration option that needs to be explicitly
set in order to serve static assets under a relative URL.
[
ci
]:
https://about.gitlab.com/gitlab-ci/
[
ci
]:
https://about.gitlab.com/gitlab-ci/
[
mkdocs
]:
http://www.mkdocs.org
[
mkdocs
]:
http://www.mkdocs.org
[
install
]:
http://www.mkdocs.org/#installation
[
install
]:
http://www.mkdocs.org/#installation
[
documentation
]:
http://www.mkdocs.org
[
mkdocs documentation
]:
http://www.mkdocs.org
[
userpages
]:
https://docs.gitlab.com/ce/user/project/pages/introduction.html#user-or-group-pages
[
material for mkdocs documentation
]:
https://squidfunk.github.io/mkdocs-material/getting-started
[
projpages
]:
https://docs.gitlab.com/ce/user/project/pages/introduction.html#project-pages
---
---
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment