Legal Information website, hosted on GitLab Pages with Mkdocs + Material for Mkdocs
Go to file
Quinn Lane 71d82cad49 🍱 Rebrand to Smartfridge Solutions 2023-01-23 08:39:34 +00:00
docs 🍱 Rebrand to Smartfridge Solutions 2023-01-23 08:39:34 +00:00
.gitignore Ignore the site_dir output directory: "public" 2020-07-21 09:55:25 -05:00
.gitlab-ci.yml Update .gitlab-ci.yml 2021-09-15 07:41:44 +00:00
.gitpod.yml 📝 Scaffold docs 2022-09-23 18:19:29 +00:00
LICENSE 📄 Set project license to Creative Commons Attribution-NoDerivatives 4.0 2022-09-29 06:33:22 +00:00
README.md Merge branch 'readme-yaml-fix' into 'master' 2022-04-22 03:48:22 +00:00
mkdocs.yml 🍱 Rebrand to Smartfridge Solutions 2023-01-23 08:39:34 +00:00
requirements.txt ⬆️ Upgrade mkdocs and material for mkdocs from the template 2022-09-02 16:00:42 +00:00

README.md

Build Status


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/.


GitLab CI

This project's static Pages are built by GitLab CI, following the steps defined in .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

To work locally with this project, you'll have to follow the steps below:

  1. Fork, clone or download this project
  2. Install MkDocs
  3. Preview your project: mkdocs serve, your site can be accessed under localhost:8000
  4. Add content
  5. Generate the website: mkdocs build (optional)

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 and project Pages.

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.


Forked from https://gitlab.com/morph027/mkdocs