mkdocs.yml

# Project information
site_name: OnTime.JS JSON Format
site_description: 'Specification of the OnTime.JS JSON Format'
site_author: 'STÜBER SYSTEMS GmbH'
site_url: 'https://doc.ontimejs-json.stueber.co.uk'

# Copyright
copyright:
  '&copy; 2021 STÜBER SYSTEMS GmbH : <a href="https://legal.stueber.de/imprint.php">Impressum</a> : <a href="https://legal.stueber.de/privacy.php">Datenschutz</a>'

# Repository
repo_name: 'On GitHub'
repo_url: 'https://github.com/stuebersystems/doc.ontimejs-json'

# Theming
theme: 
    name: material
    language: de
    features:
        - navigation.footer
        - navigation.instant
        - navigation.tabs
        - navigation.top
        - search.highlight
        - search.share
        - search.suggest
        - toc.follow
    palette:
        primary: 'indigo'
        accent: 'amber'
    font: false
    favicon: assets/logos/favicon.ico
    logo: 'assets/logos/logo.svg'
    include_search_page: false
    search_index_only: true
    static_templates:
      - 404.html

# Customization
extra_css:
    - assets/css/custom.css

# Plugins    
plugins:
    - search
    - minify:
        minify_html: true
        
# Extensions    
markdown_extensions:
  - markdown.extensions.admonition
  - markdown.extensions.abbr
  - markdown.extensions.attr_list
  - markdown.extensions.def_list
  - markdown.extensions.footnotes
  - markdown.extensions.meta
  - markdown.extensions.toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.tasklist:
      custom_checkbox: true  
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  
# Navigation  
nav:
- Introduction: index.md
- Objects:
  - onplan: objects/onplan.md
  - result: objects/result.md
  - about: objects/about.md
  - note: objects/note.md
  - user: objects/user.md
  - users: objects/users.md
  - Schedule objects: 
    - classAbsence: objects/classAbsence.md
    - roomAbsence: objects/roomAbsence.md
    - teacherAbsence: objects/teacherAbsence.md
    - displaySchedule: objects/displaySchedule.md
  - Catalogue objects:
    - area: objects/area.md
    - building: objects/building.md
    - candidate: objects/candidate.md
    - catalogEntry: objects/catalogEntry.md
    - class: objects/class.md
    - course: objects/course.md
    - resource: objects/resource.md
    - room: objects/room.md
    - student: objects/student.md
    - subject: objects/subject.md
    - teacher: objects/teacher.md
    - team: objects/team.md
    - timeframe: objects/timeframe.md