Added documentation generation in .gitlab-ci.yml
This commit is contained in:
BIN
docs/docs/assets/logo.png
Normal file
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
3
docs/docs/index.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Home
|
||||
|
||||
An example README that you can replace with your own content!
|
||||
7
docs/docs/stylesheets/extra.css
Normal file
7
docs/docs/stylesheets/extra.css
Normal file
@@ -0,0 +1,7 @@
|
||||
:root {
|
||||
--md-primary-fg-color: #8191ff;
|
||||
}
|
||||
|
||||
.md-header {
|
||||
background-color: #232323;
|
||||
}
|
||||
37
docs/mkdocs.yml
Normal file
37
docs/mkdocs.yml
Normal 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
3
docs/requirements.txt
Normal file
@@ -0,0 +1,3 @@
|
||||
mkdocs==1.5.3
|
||||
mkdocs-material==9.5.12
|
||||
mike==2.0.0
|
||||
Reference in New Issue
Block a user