mkdocs.yml

# This configuration can be changed from this https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/
# I will be putting comments on certain places where necessary

site_name: Coders for Causes Workshops
author: Coders for Causes # remove this if you removed the override/partial
author_website: https://codersforcauses.org/ # remove this if you removed the override/partial
repo_url: https://github.com/codersforcauses/workshops/

# This uri refers to the github path to edit, change this if you branch is different in name
edit_uri: edit/main/docs/
theme:
  name: material
  custom_dir: overrides # remove this if you removed the override/partial
  palette:
  - media: "(prefers-color-scheme: light)" # below here is a palette for light mode
    scheme: cfclight
    toggle:
      icon: material/toggle-switch-off-outline
      name: Switch to dark mode
  - media: "(prefers-color-scheme: dark)"  # below here is a palette for dark mode
    scheme: cfcdark
    toggle:
      icon: material/toggle-switch
      name: Switch to light mode

  logo: images/cfc_logo_white_circle.png
  favicon: images/cfc_logo_white_circle.png
  features: # Refer to https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/
      - navigation.instant
      - navigation.tabs
      - toc.integrate
      - header.autohide
      - content.code.annotate

plugins:
  - search

# These are markdown extensions I have included that makes the documentation look nicer
# These extensions are from here https://facelessuser.github.io/pymdown-extensions/
markdown_extensions:
  - admonition
  - attr_list
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.details
  - pymdownx.smartsymbols
  - pymdownx.highlight:
      use_pygments: true
      linenums: true
  - pymdownx.tabbed
  - footnotes
  - pymdownx.critic
  - attr_list
  - def_list
  - pymdownx.tasklist
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - tables
  - toc:
      permalink: true
      toc_depth: 2
  - codehilite
  - pymdownx.snippets:
      base_path: docs
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

extra:
  social:
    - icon: octicons/globe-16
      link: https://codersforcauses.org/
    - icon: fontawesome/brands/instagram
      link: https://www.instagram.com/cfc_uwa/
    - icon: fontawesome/brands/facebook
      link: https://www.facebook.com/codersforcauses
    - icon: fontawesome/brands/youtube
      link: https://www.youtube.com/channel/UCp47I0qUXeGgSK0AtFJSkbQ
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/coders-for-causes/
    - icon: fontawesome/solid/paper-plane
      link: mailto:hello@codersforcauses.org


# Add google Analytics when you need it
# Remove this if you dont need it
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/
# google_analytics:
#   - UA-162451015-2 
#   - auto

# This is the extra javascript included in the documentation
extra_javascript:
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
  - https://cdnjs.cloudflare.com/ajax/libs/tablesort/5.2.1/tablesort.min.js
  - javascripts/tablesort.js

# If you want to put extra CSS
extra_css:
  - stylesheets/extra.css

# This is where you adjust the hierarchy if the documentation
# You can erase this if you want. If you erase this, Mkdocs will alphabetically sort your documentation
nav:
- About: 
  - Overview: index.md
  - Contributions: contributions.md
- 2024/2025 Summer:
  - Introduction to Web Development: 2024-2025-summer/introduction-to-web-development.md
  - Practical Software Engineering Workflow: 2024-2025-summer/practical-software-engineering-workflow.md
  - Working With Typescript: 2024-2025-summer/working-with-typescript.md
- 2024 Winter:
  - Introduction to Web Development: 2024-winter/introduction-to-web-development.md
  - Practical Software Engineering Workflow: 2024-winter/practical-software-engineering-workflow.md
  - Introduction to Docker: 2024-winter/introduction-to-docker.md
  - Introduction to Backend Development With Django: 2024-winter/introduction-to-backend-development-with-django.md
- 2023 Winter:
  - Introduction to Backend Development With Django: 2023-winter/introduction-to-backend-development-with-django.md
- 2022/2023 Summer:
  - Overview: 2022-2023-summer/index.md
  - Setup: 2022-2023-summer/setup.md
  - Introduction to Web Development: 2022-2023-summer/introduction-to-web-development.md
  - Practical Software Engineering Workflow: 2022-2023-summer/practical-software-engineering-workflow.md
  - MVC and MVVM Software Architectural Patterns and Communications: 2022-2023-summer/mvc-mvvm-architecture-and-communications.md
- 2021/2022 Summer:
  - Overview: 2021-2022-summer/index.md
  - Setup: 2021-2022-summer/setup.md
  - Project and Workshop Structure: 2021-2022-summer/project-and-workshop-structure.md
  - Introduction to Web Development: 2021-2022-summer/introduction-to-web-development.md
  - Introduction to Web Basics: 2021-2022-summer/introduction-web-basics.md
  - Practical Software Engineering Practices: 2021-2022-summer/practical-software-engineering-practices.md
  - Introduction to Frontend Frameworks: 
    - Overview: 2021-2022-summer/introduction-to-frontend-frameworks.md
    - Introduction to React: 2021-2022-summer/introduction-to-react.md
    - Introduction to Vue: 2021-2022-summer/introduction-to-vue.md
  - Introduction to Backend Development with Django: 2021-2022-summer/introduction-to-backend-development-with-django.md
  - MVC-MVMM Architecture and Communications: 2021-2022-summer/mvc-mvmm-architecture-and-communications.md
  - Package Managers: 2021-2022-summer/package-managers.md
  - Typical Codebase Structure: 2021-2022-summer/typical-codebase-structure.md
  - Automated Testing and CI Pipelines: 2021-2022-summer/automated-testing-and-ci-pipelines.md
- 2021 Winter:
  - Overview: 2021-winter/index.md