mkdocs.yml

site_name: "Hacking Summer School"   #Name of Site

site_url: https://github.coventry.ac.uk/pages/CUEH/SummerSchool/  #Update this to
repo_name: CUEH/Summerschool  #What we want to call the repo on the page
repo_url: https://github.coventry.ac.uk/CUEH/SummerSchool  #If we want a link to the repo

site_description:  Ethical Hacking Summer School
site_author: Dan Goldsmith
#copyright: 2022-24 Dan Goldsmith

# --------------- Theme Related Settings ---------------
theme:
  name: material
  #logo: Optional-Logo
  #favicon: Optional-Favicon
  
  features:
    - navigation.top  #Have a "Go to top button
    #- navigation.indexes #Allow us to attach something as a "Home page" for sections.
    - content.code.copy
    - content.code.annotate
    #- toc.integrate   # Intergrate the pages TOC into the Nav
    #- navigation.tabs  #We can have Top level as tabs, but I dont really like it.
    
  custom_dir: custom_theme   #Where we put any customisations

  
  font: false  #Dont Load Fonts from Google
  
  palette:   #
    - scheme: default
      toggle:  
        icon: material/weather-night 
        name: dark mode
    - scheme: slate
      toggle:
        icon: material/weather-sunny
        name: light mode
    - scheme: stan
      toggle:
        icon: material/beer-outline
        name: Stan Mode
    - scheme: stan-dark
      toggle:
        icon: material/beer
        name: Stan Dark

        
plugins:
  - tags:
      tags_file: tags.md
#  - social:
#      cards: true
#      cards_layout_options:
#        background_color: "#0FF1CE"

#extra:
#  analytics:  #Allow use of Analytics
#    provider: plausible
#    script: '<!-- Analytics Script to go here -->'
#  version:    #Aloow versioning via Mike. (https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/)
#    provider: mike

markdown_extensions:
  - meta
  - admonition
  - def_list  
  - footnotes
  - abbr
  - toc
  - pymdownx.highlight
  - pymdownx.tabbed   #For Tabbed Sourcecode
  - pymdownx.details
  - pymdownx.keys
  - pymdownx.tasklist
  - pymdownx.smartsymbols
  - pymdownx.tilde
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.emoji: #Custom Icons (Looks like we need the Emojii)
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      options:
        custom_icons:
          - custom_theme/.icons
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format          
          
extra_css:
  - assets/stylesheets/local_fonts.css
  - assets/stylesheets/stan.css
  - assets/stylesheets/custom.css
  - assets/stylesheets/custom_admonitions.css


# extra_javascript:
#   - assets/javascripts/config.js
#   - https://polyfill.io/v3/polyfill.min.js?features=es6
#   - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js


nav:
  - Home: index.md
  - Draft Schedule: 2024_Timetable.pdf
  - Week 1:
    - Introduction: intro/index.md
    - Linux:
      - Kali Linux: intro/kali.md
      - Command Line History: intro/commandline.md
      - Command Line Introduction: intro/linux_terminal.md
      - Creating Files and Folders: intro/linux_creating_folders.md
      - Moving Files: intro/linux_moving_files.md
      - Hidden Files: intro/hidden_files.md
      - The Superuser: intro/superuser.md
      - Pipes, and IO Redirection: intro/linux_pipes.md
      - Linux Task / Challenge: intro/linux_task.md
    - Python for Hackers:
        - Introduction: python/index.md
        - Setup: python/before_you_start.md
        - Port Scanning: python/PortScanning.md
        - Password Cracking: python/password-cracking.md
  - Week 2 Privesc:
    - Introduction: privesc/index.md
#    - Slides: privesc/Slides/Privesc.html     
    - Privilege Escalation: privesc/Privesc.md
    - Linux Permissions Intro: privesc/LinuxPermissions.md
    - Windows Permissions Intro: privesc/WindowsPermissions.md
    - "Linux: ACLs": privesc/ACL.md
    - Legitimately Elevating Privileges:
      - Sudo: privesc/Sudo.md
      - Sudo Walkthrough: privesc/Sudo_Walkthrough.md
      - SUID: privesc/SUID.md
      - SUID Walkthrogh: privesc/SUID_Walkthrough.md
      - Capabilities: privesc/Capabilites.md
      - Capabilities Walkthrough: privesc/Capability_Walkthrough.md
    - Videos: privesc/videos.md        
  - Week 3 Web Hacking:
    - Remote Shells:
      - Introduction: Shells/index.md
      - Slides: Shells/Slides/shells.html
      - Shells: Shells/IntroToShells.md
#      - Remote Shells: Shells/RemoteShells.md
      - Netcat: Shells/Netcat.md
      - RCE: Shells/RCE.md
      - Web Shells: Shells/WebShells.md
      - SSH (Extra Notes): Shells/SSH.md
      - Shells Lab Activity: Shells/Lab_Web.md
    - SQL Injection:
      - Introduction: SQLi/index.md
      - SQL Basics and Syntax: SQLi/SQLBasicsAndSyntax.md
      - SQLi Intro: SQLi/SQLI.md
      - Database Enumeration: SQLi/DatabaseEnumeration.md
      - Blind SQL: SQLi/BlindSQL.md
      - SQLi Lab Activity: SQLi/Lab_SQLi.md
      - Videos: SQLi/videos.md
      - Slides: SQLi/Slides/SQLi.html


#  - Slides: includes.md
#  - Essentials:
#    - Module Guide: essentials/moduleguide.md

  - Tags: tags.md
  # - Assesment:
  #   - Assessment Overview: assessment/assessment.md
  #   - Assessment Example: assessment/ExampleCW.md