feat: Added docs via MkDocs

This commit is contained in:
AURUMVORXX
2024-11-04 05:09:59 +03:00
parent 810dd00dd8
commit 6a20d96bb5
21 changed files with 299 additions and 63 deletions

57
mkdocs.yml Normal file
View File

@@ -0,0 +1,57 @@
site_name: PyG2O
markdown_extensions:
- nl2br
- admonition
- pymdownx.details
- pymdownx.superfences
- sane_lists
plugins:
- mkdocstrings
- search
- callouts
repo_url: https://github.com/AURUMVORXX/PyG2O.git
nav:
- Home: index.md
- Events:
- General:
- onInit: defaultEvents/onInit.md
- onExit: defaultEvents/onExit.md
- onTick: defaultEvents/onTick.md
- onTime: defaultEvents/onTime.md
- onBan: defaultEvents/onBan.md
- onUnban: defaultEvents/onUnban.md
- Functions:
- Events:
- event: events/event.md
- removeEventHandler: events/removeEventHandler.md
- addEvent: events/addEvent.md
- callEvent: events/callEvent.md
theme:
name: material
features:
- search.suggest
- search.highlight
- content.tabs.link
- content.code.annotation
- content.code.copy
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
primary: black