Nathan Schneider 207122f777 Update docs/mediums/sortition.md | 5 роки тому | |
---|---|---|
docs | 5 роки тому | |
.gitlab-ci.yml | 5 роки тому | |
README.md | 7 роки тому | |
mkdocs.yml | 5 роки тому |
Example MkDocs website using GitLab Pages.
Learn more about GitLab Pages at https://pages.gitlab.io and the official documentation https://docs.gitlab.com/ce/user/project/pages/.
This project's static Pages are built by GitLab CI, following the steps
defined in .gitlab-ci.yml
:
image: python:alpine
before_script:
- pip install mkdocs
## Add your custom theme if not inside a theme_dir
## (https://github.com/mkdocs/mkdocs/wiki/MkDocs-Themes)
# - pip install mkdocs-material
pages:
script:
- mkdocs build
- mv site public
artifacts:
paths:
- public
only:
- master
To work locally with this project, you'll have to follow the steps below:
mkdocs serve
,
your site can be accessed under localhost:8000
mkdocs build
(optional)Read more at MkDocs documentation.
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 this line
in your mkdocs.yml
, from "https://pages.gitlab.io/mkdocs/"
to
site_url = "https://namespace.gitlab.io"
.
Read more about user/group Pages and project Pages.
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.
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.
Forked from https://gitlab.com/morph027/mkdocs