Added documentation generation in .gitlab-ci.yml

This commit is contained in:
Patrix
2024-03-04 01:02:39 +01:00
parent bc331091ab
commit 989a1a0a8b
7 changed files with 129 additions and 16 deletions

BIN
docs/docs/assets/logo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.6 KiB

3
docs/docs/index.md Normal file
View File

@@ -0,0 +1,3 @@
# Home
An example README that you can replace with your own content!

View File

@@ -0,0 +1,7 @@
:root {
--md-primary-fg-color: #8191ff;
}
.md-header {
background-color: #232323;
}

37
docs/mkdocs.yml Normal file
View File

@@ -0,0 +1,37 @@
site_name: Squirrel Template Module - Docs
repo_url: https://gitlab.com/GothicMultiplayerTeam/modules/squirrel-template
repo_name: Squirrel Template Module
edit_uri: ""
site_dir: "public"
extra_css:
- stylesheets/extra.css
extra:
version:
provider: mike
markdown_extensions:
- admonition
- attr_list
- pymdownx.tabbed
- pymdownx.highlight
- pymdownx.superfences
theme:
name: material
logo: assets/logo.png
icon:
repo: fontawesome/brands/gitlab
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/eye-outline
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/eye
name: Switch to light mode

3
docs/requirements.txt Normal file
View File

@@ -0,0 +1,3 @@
mkdocs==1.5.3
mkdocs-material==9.5.12
mike==2.0.0