From e0fb9a1167b2387e22185a7091d4962b6d9795e9 Mon Sep 17 00:00:00 2001 From: 201st-Luka Date: Thu, 7 Sep 2023 21:23:25 +0200 Subject: [PATCH] docs: creating mkdocs.yml --- docs/index.md | 2 +- mkdocs.yml | 41 +++++++++++++++++++++++++++++++++-------- 2 files changed, 34 insertions(+), 9 deletions(-) diff --git a/docs/index.md b/docs/index.md index ae29e74..bfee35c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -28,7 +28,7 @@ pip install git+https://github.com/201st-Luka/PyClasher.git@v1.0.0-alpha1 --- -##### Disclaimer +## Disclaimer This material is unofficial and is not endorsed by Supercell. For more information see Supercell's Fan Content Policy: www.supercell.com/fan-content-policy. diff --git a/mkdocs.yml b/mkdocs.yml index 1a333c9..7d5f5f7 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,5 +1,10 @@ site_name: PyClasher site_url: https://201st-Luka.github.io/pyclasher/ +copyright: Copyright © Copyright (c) 2023 - Present 201st-Luka +repo_url: https://github.com/201st-Luka/PyClasher +repo_name: 201st-Luka/PyClasher +edit_uri: edit/main/docs/ + nav: - Home: index.md @@ -8,28 +13,48 @@ theme: name: material features: - navigation.tabs + - navigation.tabs.sticky - navigation.sections - - toc.integrate + - navigation.instant + - navigation.tracking + - navigation.path + - navigation.prune - navigation.top - search.suggest + - search.share - search.highlight - content.tabs.link - content.code.annotation - content.code.copy language: en palette: - - scheme: default + - media: "(prefers-color-scheme: light)" + scheme: default + primary: indigo + accent: orange toggle: - icon: material/toggle-switch-off-outline + icon: material/brightness-7 name: Switch to dark mode + - media: "(prefers-color-scheme: dark)" + scheme: slate primary: indigo accent: orange - - scheme: slate toggle: - icon: material/toggle-switch + icon: material/brightness-3 name: Switch to light mode - primary: indigo - accent: orange + icon: fontawesome/brands/github plugins: - - search + - search: + lang: en + +extra: + version: + provider: mike + social: + - icon: fontawesome/brands/discord + link: https://discord.gg/j2PAF9Wru8 + name: Become part of the 201st Community + - icon: fontawesome/brands/github + link: https://github.com/201st-Luka/PyClasher + name: PyClasher on GitHub