From 1b8b91ec2fd2700bd26377beac7d57cb207af0bb Mon Sep 17 00:00:00 2001 From: KTrain5369 <69028025+KTrain5169@users.noreply.github.com> Date: Sun, 20 Oct 2024 11:29:37 +1000 Subject: [PATCH] add extra stuff to the docs page --- docs/index.md | 2 +- docs/instructions.md | 2 +- mkdocs.yml | 42 +++++++++++++++++++++++++++++++++++++++--- 3 files changed, 41 insertions(+), 5 deletions(-) diff --git a/docs/index.md b/docs/index.md index 840b29c..8d46252 100644 --- a/docs/index.md +++ b/docs/index.md @@ -8,5 +8,5 @@ Other useful links: - [Prism Launcher Community CatPacks (Discord)](https://discord.com/channels/1031648380885147709/1278732669525561486) - [Issue tracker](https://github.com/KTrain5169/CatPackMaker/issues) -- [Discord server](https://discord.gg/G6YvWhctjk) (Ask for support in there!) - [Pull requests](https://github.com/KTrain5169/CatPackMaker/pulls) +- [Discord server](https://discord.gg/G6YvWhctjk) (Ask for support in there!) diff --git a/docs/instructions.md b/docs/instructions.md index c767b7d..0189e93 100644 --- a/docs/instructions.md +++ b/docs/instructions.md @@ -36,4 +36,4 @@ This should be located at `../PrismLauncher/catpacks`, where `..` varies dependi - Scoop: `%HOMEPATH%/scoop/persist` - Note that the directory may be seen as `prismlauncher` instead of `PrismLauncher`. This is as intended. - Flatpak: `~/.var/app/org.prismlauncher.PrismLauncher/data` - diff --git a/mkdocs.yml b/mkdocs.yml index 9316b91..310b2a4 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,13 +1,49 @@ site_name: CatPack Crafter docs +site_description: Documentation for the CatPack Crafter. +site_author: KTrain5369 +copyright: Copyright 2024 by KTrain5369 + repo_name: GitHub source repo_url: https://github.com/KTrain5169/CatPackMaker edit_uri: blob/main/docs/ -site_description: Documentation for the CatPack Crafter. -site_author: KTrain5369 + theme: name: material + icon: + repo: fontawesome/brands/github + palette: + - media: "(prefers-color-scheme: light)" + scheme: default + primary: purple + accent: indigo + toggle: + icon: material/weather-sunny + name: Switch to dark mode + - media: "(prefers-color-scheme: dark)" + scheme: slate + primary: purple + accent: indigo + toggle: + icon: material/weather-night + name: Switch to light mode + +extra: + social: + - icon: fontawesome/brands/github + link: https://github.com/KTrain5169 + - icon: fontawesome/brands/discord + link: https://discord.gg/G6YvWhctjk + nav: - Home: index.md - Download: downloads.md - How to use: instructions.md - - Contributing: contributing.md \ No newline at end of file + - Contributing: contributing.md + - Run from source: run-from-source.md + +markdown_extensions: + - toc: + permalink: true + +plugins: + - search \ No newline at end of file