From 3c8feb3d01473fcfb959da2e497b49d066637919 Mon Sep 17 00:00:00 2001 From: Marcus Baw Date: Mon, 25 Mar 2024 21:38:23 +0000 Subject: [PATCH] removes Docker Compose version as it's obsolete and deprecated switch to a local development port which is unique across RCPCH sites, to avoid clashes --- docker-compose.yml | 4 ++-- mkdocs.yml | 41 +++++++++++++++++++++++++++++------------ 2 files changed, 31 insertions(+), 14 deletions(-) diff --git a/docker-compose.yml b/docker-compose.yml index 86805a8..af2c5ea 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,4 +1,4 @@ -version: "3.11" # Docker Compose specification version! NOT the Python version +# docker compose file for rcpch.tech services: mkdocs: @@ -6,7 +6,7 @@ services: volumes: - .:/app/ ports: - - 8001:8001 + - 8022:8000 environment: - ENABLE_GIT_COMMITTERS=False # Disables git committer extension in local dev - ENABLE_PDF_EXPORT=0 # Disables automatic PDF generation in local dev diff --git a/mkdocs.yml b/mkdocs.yml index db65b79..1ac7cd4 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -8,20 +8,21 @@ site_url: https://rcpch.tech copyright: Copyright © 2024 Royal College of Paediatrics and Child Health (RCPCH) # these lines configure the 'GitHub repo' widget on the top right -repo_url: https://github.com/rcpch/rcpch.tech -repo_name: rcpch/rcpch.tech -edit_uri: blob/live/docs +# COMMENTED OUT AS NOT REALLY NEEDED FOR POC rcpch.tech SITE 20.03.2024 +# repo_url: https://github.com/rcpch/rcpch.tech +# repo_name: rcpch/rcpch.tech +# edit_uri: blob/live/docs # `mkdocs serve` serves the documentation at custom port (to avoid clashing with other services we commonly run) -dev_addr: "0.0.0.0:8001" +dev_addr: "0.0.0.0:8000" # theme settings, fonts, colours theme: name: material #custom_dir: rcpch-theme features: - - content.action.edit # explicitly adds edit button (Material4MkDocs9.0) - - content.action.view # explicitly adds view button (Material4MkDocs9.0) + # - content.action.edit # COMMENTED OUT AS NOT REALLY NEEDED FOR POC rcpch.tech SITE 20.03.2024 + # - content.action.view # COMMENTED OUT AS NOT REALLY NEEDED FOR POC rcpch.tech SITE 20.03.2024 - navigation.expand - navigation.footer # explicitly adds footer prev/next (Material4MkDocs9.0) - navigation.instant @@ -32,8 +33,22 @@ theme: # - toc.integrate palette: - # Light mode only for now - scheme: default + # Palette toggle for dark mode + - scheme: slate + primary: deep purple + accent: blue + toggle: + icon: material/brightness-4 + name: Switch to light mode + + # Palette toggle for light mode + - scheme: default + primary: deep purple + accent: blue + toggle: + icon: material/brightness-7 + name: Switch to dark mode + font: text: Montserrat @@ -44,13 +59,15 @@ theme: # mkdocs plugins plugins: - - git-committers: - repository: rcpch/rcpch.tech - branch: live - enabled: !ENV [ENABLE_GIT_COMMITTERS, false] # makes Git Committers optional + # COMMENTED OUT AS NOT REALLY NEEDED FOR POC rcpch.tech SITE 20.03.2024 + # - git-committers: + # repository: rcpch/rcpch.tech + # branch: live + # enabled: !ENV [ENABLE_GIT_COMMITTERS, false] # makes Git Committers optional # - git-revision-date-localized: # enable_creation_date: true - search + # COMMENTED OUT AS NOT REALLY NEEDED FOR POC rcpch.tech SITE 20.03.2024 # - with-pdf: # back_cover: false # cover_title: rcpch.tech