mkdocs.yml

# Copyright (c) 2016-2020 Martin Donath <martin.donath@squidfunk.com>

# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to
# deal in the Software without restriction, including without limitation the
# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
# sell copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:

# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.

# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE.

# Project information
site_name: Notenverwaltung an der Grundschule Waltersdorf
site_url: https://notenverwaltung.github.io/Notenverwaltungssoftware/
site_author: David, Lukas, Tony
site_description: >-
  Projekt: Implementierung und Validierung einer Notenverwaltung an der Grundschule Waltersdorf

repo_url: https://github.com/notenverwaltung/Notenverwaltungssoftware
repo_name: Notenverwaltung
# Copyright
copyright: Copyright &copy; 2020 David, Lukas, Tony

# Configuration
theme:
  custom_dir: docs/overrides
  logo: assets/logo.svg
  name: material
  
  # 404 page
  static_templates:
    - 404.html

  # Don't include MkDocs' JavaScript
  include_search_page: false
  search_index_only: true

  # Default values, taken from mkdocs_theme.yml
  language: de
  features:
    - navigation.tabs
    #- navigation.instant
  palette:
    scheme: default
    primary: indigo
    accent: indigo
  font:
    text: Roboto
    code: Roboto Mono
  favicon: images/favicon.png
  icon:
    logo: logo
    repo: fontawesome/brands/github

# Plugins
plugins:
  - search
  - git-revision-date-localized:
      type: datetime
      fallback_to_build_date: false
  - redirects:
      redirect_maps:
        extensions/admonition.md: reference/admonitions.md
        extensions/codehilite.md: reference/code-blocks.md
        extensions/footnotes.md: reference/footnotes.md
        extensions/metadata.md: reference/meta-tags.md
        extensions/permalinks.md: setup/setting-up-navigation.md #permalink
        extensions/pymdown.md: reference/admonitions.md
        plugins/revision-date.md: setup/adding-a-git-repository.md #revision-date
        plugins/search.md: setup/setting-up-site-search.md
        releases/4.md: upgrading.md #upgrading-from-4x-to-5x
        releases/5.md: upgrading.md #upgrading-from-3x-to-4x
        releases/changelog.md: changelog.md
        setup/adding-social-links.md: setup/setting-up-the-footer.md
        sponsorship.md: insiders.md
  - minify:
      minify_html: true

# Customization
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/notenverwaltung/Notenverwaltungssoftware
    - icon: fontawesome/brands/instagram
      link: https://instagram.com/david_krmn
    - icon: fontawesome/brands/instagram
      link: https://instagram.com/senguja
    - icon: fontawesome/brands/instagram
      link: https://instagram.com/tony.pbt

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - https://cdnjs.cloudflare.com/ajax/libs/tablesort/5.2.1/tablesort.min.js
  - javascripts/tables.js
  
# Extensions
markdown_extensions:
  - admonition
  - abbr
  - attr_list
  - def_list
  - footnotes
  - meta
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - 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.magiclink:
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - 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
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

# Page tree
nav:
    - Startseite: 'index.md'
    - 'Grobentwurf':
        - 'Projektdefinition': 'grobkonzept/Projektdefinition.md' 
        - 'Problemanalyse': 'grobkonzept/Problemanalyse.md'
        - 'Projekt- & Sollziele': 'grobkonzept/Projekt- & Sollziele.md'
        - 'Risikoanalyse': 'grobkonzept/Risikoanalyse.md'
        - 'Dienstanalyse': 'grobkonzept/Dienstanalyse.md'
        - 'Hardwareanalyse': 'grobkonzept/Hardwareanalyse.md'
        - 'Nutzwertanalyse': 'grobkonzept/Nutzwertanalyse.md'
        - 'Literaturverzeichnis': 'grobkonzept/Literaturverzeichnis.md'
        - 'Abbildungsverzeichnis': 'grobkonzept/Abbildungsverzeichnis.md'
        - 'Tabellenverzeichnis': 'grobkonzept/Tabellenverzeichnis.md'
        - 'Anhang': 'grobkonzept/Projektauftrag.md'
    - 'Feinplanung':
        - 'Zeitplan': 'feinkonzept/Ganttdiagramm.md'
        - 'Netzwerkplan und Konten für user-stories': 'feinkonzept/Netzwerkplan.md'
        - 'User Stories': 'feinkonzept/user_stories.md'
        - 'Datenschutz und Datensicherung': 'feinkonzept/Datensicherung.md'
        - 'konzeptionelles Datenmodell': 'feinkonzept/Datenmodell.md'
        - 'Kostenkalkulation': 'feinkonzept/Kostenkalkulation.md'
        - 'Literaturverzeichnis': 'feinkonzept/Quellenverzeichnis.md'
        - 'Abbildungsverzeichnis': 'feinkonzept/abbildungsverzeichnis.md'
        - 'Tabellenverzeichnis': 'feinkonzept/tabellenverzeichnis.md'


    - 'Implementierung':
        - 'Dokumentation': 'implementierung/Dokumentation.md'
        - 'Handbuch': 'implementierung/Handbuch.md'
        - 'Download der Notenverwaltungssoftware': 'implementierung/Download.md'
    - 'Impressum':
        - 'Impressum': 'impressum/Impressum.md'