mkdocs.yml

site_name: MkDocs-material Documentation
repo_url: https://github.com/hamk-business-information-technology/mkdocs-material-documentation
edit_uri: edit/main/docs/ # to let content.action.edit / view redirect to `main`, not `master`
repo_name: hamk-bit-ca/documentation
theme:
  name: material
  logo: assets/favicon/logo_light_pink.png
  favicon: assets/favicon/favicon.png
  features:
    - content.tabs.link
    - content.code.copy
    - content.code.annotate
    - content.action.edit # link to edit, the repo_url must also be given
    - content.action.view # link to view, the repo_url must also be given
    - navigation.tabs
    - navigation.sections
#    - navigation.expand # needed for larger webservers
    - navigation.path # needed for larger webservers
    - navigation.top # go to top button
    - navigation.footer # next and back buttons in footer
#    - navigation.tabs.sticky
    - search # as part of feature, works when plugins off. If plugins on: search must be on in plugins to be enabled.
    - search.sidebar
    - search.suggest
    - search.highlight
#    - toc
#    - toc.sidebar
#    - toc.follow
    - toc.integrate # this integrate the right side toc to the left side nav
  language: en
  palette:
    # Palette toggle for dark mode
    - scheme: slate # put slate first to make dark mode the default one
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode
        primary: custom
        accent: custom
    # Palette toggle for light mode
    - scheme: default #HAMK
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
        primary: custom
        accent: custom
  
extra:
  social:
    - icon: simple/moodle
      link: https://learn.hamk.fi/
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/school/hamk/
    - icon: fontawesome/solid/paper-plane
      link: mailto:firstname.lastname@hamk.fi
  status:
    new: New feature
    experimental: experimental

extra_css:
  - https://fonts.googleapis.com/css2?family=Inter:wght@400;700&display=swap
  - https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.2/css/all.min.css
  - https://cdnjs.cloudflare.com/ajax/libs/octicons/8.5.0/build.css
  - https://cdn.jsdelivr.net/npm/@mdi/font@6.5.95/css/materialdesignicons.min.css
  - css/custom.css
extra_javascript:
  - js/custom.js

markdown_extensions:
  - attr_list
  - admonition
  - md_in_html
  - pymdownx.details
  - codehilite:
#      linenums: true # globally adding line numbers to all code blocks
                      # code blocks by indentation need this
      guess_lang: false
      css_class: highlight
      pygments_style: friendly
  - pymdownx.highlight:
      anchor_linenums: true # I did not see a difference with or w/o this (Q)
      line_spans: __span # I did not see a difference with or w/o this (Q)
      use_pygments: true # I did not see a difference with or w/o this (Q)
      pygments_lang_class: true # I did not see a difference with or w/o this (Q)
      auto_title: true # I did not see a difference with or w/o this (Q)
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true
      title: On this HAMK page
      permalink_title: anchor link to this section for reference
  # to use mkdocs-material library of icons (md)
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

nav:
  - Home: index.md
  - Overview: overview.md
  - Setting up: settingUp.md
  - Editing a page: editing.md
  - Code blocks: codeBlocks.md
  
# plugins:
#  - offline:
#      enabled: !ENV [OFFLINE, false] # if true, the rendered url will differ with .html ending
#  - info # this is to report bug to mkdocs-material only
#  - search # must be on if plugins on

copyright:
  Copyright &copy; 2024 <a href="https://www.hamk.fi/en/" target="blank" >Häme University of Applied Sciences (HAMK)</a>