mkdocs.yml

site_name: College Project & Seminar Roadmap
site_description: The guide we wish we had when we were in 3rd year. A comprehensive roadmap for students to ace their Mini Projects, Main Projects, and Seminars.
site_author: CodeCompass Team
site_url: https://CodeCompasss.github.io/College-Project-and-Seminar-Roadmap/

# Repository
repo_name: College-Project-and-Seminar-Roadmap
repo_url: https://github.com/CodeCompasss/College-Project-and-Seminar-Roadmap
edit_uri: edit/main/docs/

theme:
  name: material
  custom_dir: overrides
  logo: assets/logo.png
  favicon: assets/favicon.ico
  
  features:
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.progress
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.path
    - navigation.top
    - navigation.footer
    - navigation.indexes
    - search.highlight
    - search.suggest
    - search.share
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - toc.follow

  font:
    text: Inter
    code: JetBrains Mono

  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to system preference
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to light mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to dark mode

plugins:
  - search
  - minify:
      minify_html: true
  - git-revision-date-localized:
      enable_if_directory_urls: true
      type: datetime
  - git-authors:
      show_email: false
  - tags

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/shadil-rayyan
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/shadilrayyan
    - icon: fontawesome/brands/linkedin
      link: https://linkedin.com/in/shadilam

  consent:
    title: Cookie consent
    description: >-
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation.

  analytics:
    provider: google
    property: G-XXXXXXXXXX

    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/emoticon-happy-outline
          name: This page was helpful
          data: 1
          note: Thanks for your feedback!
        - icon: material/emoticon-sad-outline
          name: This page could be improved
          data: 0
          note: >-
            Thanks for your feedback! Help us improve this page using our
            <a href="..." target="_blank" rel="noopener">feedback form</a>.

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - tables
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

nav:
  - Home: index.md
  - 🛠️ Mini Project:
    - Overview: mini-project/index.md
    - Ideation & Topic Selection: mini-project/ideation.md
    - Implementation Guide: mini-project/implementation.md
    - Final Submission: mini-project/documentation.md
  - 🚀 Main Project:
    - Overview: main-project/index.md
    - Phase 1 (Planning): main-project/phase-1.md
    - Phase 2 (Execution): main-project/phase-2.md
    - Final Report writing: main-project/final-report.md
    - Viva Voce Preparedness: main-project/viva-voce.md
  - 🎤 Technical Seminar:
    - Overview: seminar/index.md
    - Topic Selection: seminar/topic-selection.md
    - Presentation & Report: seminar/presentation-tips.md
  - 🍱 Team & Soft Skills:
    - Building the Team: resources/team-dynamics.md
  - 💡 Resources:
    - Project Ideas: resources/project-ideas.md
    - Scoring High - Tips: resources/scoring-tips.md
    - Useful Templates: resources/templates.md
    - Student Confessions: resources/confessions.md