feat(docs): read through mkdocs material documentation and enabled a whole bunch of qol features

This commit is contained in:
Seaswimmer 2024-01-07 18:52:25 +00:00
parent 174775daad
commit c179dd0649
Signed by untrusted user: cswimr
GPG key ID: D74DDDDF420E13DF
2 changed files with 27 additions and 3 deletions

View file

@ -37,6 +37,7 @@ jobs:
- name: Build documentation - name: Build documentation
run: | run: |
export SITE_URL="https://$CI_ACTION_REF_NAME_SLUG.seacogs.coastalcommits.com" 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 mkdocs build -v
continue-on-error: true continue-on-error: true

View file

@ -2,7 +2,7 @@
site_url: !ENV [SITE_URL, 'https://seacogs.coastalcommits.com'] site_url: !ENV [SITE_URL, 'https://seacogs.coastalcommits.com']
repo_name: CoastalCommits repo_name: CoastalCommits
repo_url: https://coastalcommits.com/SeaswimmerTheFsh/SeaCogs 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 copyright: Copyright © 2024, SeaswimmerTheFsh
docs_dir: .docs docs_dir: .docs
@ -12,7 +12,7 @@ site_description: Documentation for my Red-DiscordBot Cogs.
nav: nav:
- Home: index.md - Home: index.md
- Aurora: - Aurora:
- Home: aurora/index.md - aurora/index.md
- Moderation Commands: aurora/moderation-commands.md - Moderation Commands: aurora/moderation-commands.md
- Case Commands: aurora/case-commands.md - Case Commands: aurora/case-commands.md
- Configuration: aurora/configuration.md - Configuration: aurora/configuration.md
@ -64,18 +64,41 @@ markdown_extensions:
theme: theme:
name: material name: material
palette: 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: features:
- content.code.annotate - content.code.annotate
- content.code.copy - content.code.copy
- navigation.instant - navigation.instant
- navigation.instant.progress
- navigation.tabs - navigation.tabs
- navigation.tracking
- navigation.top
- navigation.sections
- navigation.indexes
- search.suggest - search.suggest
- search.highlight - search.highlight
- search.share - search.share
- toc.follow
logo: img/logo.png logo: img/logo.png
favicon: img/logo.png favicon: img/logo.png
icon:
repo: simple/forgejo
watch: watch:
- ./aurora - ./aurora
- ./nerdify - ./nerdify
- ./updatechecker