From c179dd06493300661f8c75ffeb1678fbc478674a Mon Sep 17 00:00:00 2001 From: SeaswimmerTheFsh Date: Sun, 7 Jan 2024 18:52:25 +0000 Subject: [PATCH] feat(docs): read through mkdocs material documentation and enabled a whole bunch of qol features --- .forgejo/workflows/workflow.yaml | 1 + mkdocs.yml | 29 ++++++++++++++++++++++++++--- 2 files changed, 27 insertions(+), 3 deletions(-) diff --git a/.forgejo/workflows/workflow.yaml b/.forgejo/workflows/workflow.yaml index 5a4a907..62967b5 100644 --- a/.forgejo/workflows/workflow.yaml +++ b/.forgejo/workflows/workflow.yaml @@ -37,6 +37,7 @@ jobs: - name: Build documentation run: | export SITE_URL="https://$CI_ACTION_REF_NAME_SLUG.seacogs.coastalcommits.com" + export EDIT_URI="src/branch/$CI_ACTION_REF_NAME/.docs" mkdocs build -v continue-on-error: true diff --git a/mkdocs.yml b/mkdocs.yml index 8446e34..01b84ed 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -2,7 +2,7 @@ site_url: !ENV [SITE_URL, 'https://seacogs.coastalcommits.com'] repo_name: CoastalCommits repo_url: https://coastalcommits.com/SeaswimmerTheFsh/SeaCogs -edit_uri: src/branch/main/.docs +edit_uri: !ENV [EDIT_URI, 'src/branch/main/.docs'] copyright: Copyright © 2024, SeaswimmerTheFsh docs_dir: .docs @@ -12,7 +12,7 @@ site_description: Documentation for my Red-DiscordBot Cogs. nav: - Home: index.md - Aurora: - - Home: aurora/index.md + - aurora/index.md - Moderation Commands: aurora/moderation-commands.md - Case Commands: aurora/case-commands.md - Configuration: aurora/configuration.md @@ -64,18 +64,41 @@ markdown_extensions: theme: name: material palette: - scheme: slate + - media: '(prefers-color-scheme: light)' + scheme: default + primary: orange + accent: amber + toggle: + icon: material/toggle-switch + name: Switch to dark mode + + - media: '(prefers-color-scheme: dark)' + scheme: slate + primary: orange + accent: amber + toggle: + icon: material/toggle-switch-off-outline + name: Switch to light mode features: - content.code.annotate - content.code.copy - navigation.instant + - navigation.instant.progress - navigation.tabs + - navigation.tracking + - navigation.top + - navigation.sections + - navigation.indexes - search.suggest - search.highlight - search.share + - toc.follow logo: img/logo.png favicon: img/logo.png + icon: + repo: simple/forgejo watch: - ./aurora - ./nerdify + - ./updatechecker