mkdocs.yml

site_name: "Master Sword: Rebirth - Documentation Project"
site_description: "Your one-stop-shop for MS:R info!"
site_url: https://www.msrebirth.net/
repo_url: https://github.com/MSRevive/msr-documentation
repo_name: MS:R Documentation
edit_uri: edit/main/docs
theme:
  features:
    - toc.follow
    - toc.integrate
    - navigation.instant
    - navigation.instant.progress
    - navigation.top
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.prune
    - navigation.indexes
    - content.action.edit
    - content.action.view
    - content.code.copy
    - content.code.annotate
    - search.suggest
    - search.highlight
    - search.share
  name: material
  icon:
    logo: fontawesome/solid/scale-balanced

  favicon: assets/MSR.ico

  palette:

    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      primary: custom
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      primary: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      primary: custom
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

markdown_extensions:
  - attr_list
  - md_in_html
  - tables
  - pymdownx.smartsymbols
  - pymdownx.blocks.caption
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      options:
        custom_icons:
          - overrides/.icons
  - pymdownx.highlight:
      anchor_linenums: true
      use_pygments: true
      auto_title: true
      linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      url_download: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - admonition
  - pymdownx.details
  - def_list
  - pymdownx.tasklist:
      custom_checkbox: true

extra_css:
  - stylesheets/extra.css

extra:
  social:
    - icon: simple/discord
      link: https://discord.gg/NR6tawhmjn
    - icon: simple/internetcomputer
      link: https://msrebirth.net/
    - icon: simple/github
      link: https://github.com/MSRevive
    - icon: simple/trello
      link: https://trello.com/b/q8gWAiWT
  
  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 and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.
    cookies:
      analytics:
        name: Google Analytics
        checked: false
    actions:
      - accept
      - manage
      - reject

  #fill out the Google Analytics property and delete this line, along with poundsigns to enable Google Analytics
  #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 by
  #          using our <a href="..." target="_blank" rel="noopener">feedback form</a>.

plugins:
  - search
  - privacy:
      enabled: !ENV [CI, false]     # requires external google links, disable on local build
  - tags
  - meta
  - social:
      enabled: !ENV [CI, false]      # requires image processing libraries, disable on local build
      cards_layout_options:
        font_family: "Macondo Swash Caps"
        background_color: "#a17033"
  - glightbox

copyright: >
  © Team MSRebirth. Goldsource & Half-Life are trademarks of Valve Corporation. Website is under Unlicensed license -
  <a href="#__consent">Change cookie settings</a>