Skip to content

Commit

Permalink
removes Docker Compose version as it's obsolete and deprecated
Browse files Browse the repository at this point in the history
switch to a local development port which is unique across RCPCH sites, to avoid clashes
  • Loading branch information
pacharanero committed Mar 25, 2024
1 parent cbb235d commit 3c8feb3
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 14 deletions.
4 changes: 2 additions & 2 deletions docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
version: "3.11" # Docker Compose specification version! NOT the Python version
# docker compose file for rcpch.tech

services:
mkdocs:
build: .
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
Expand Down
41 changes: 29 additions & 12 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down

0 comments on commit 3c8feb3

Please sign in to comment.