mkdocs.yml

site_name: BetonQuest
site_author: BetonQuest Organisation
site_url: https://betonquest.org/
site_dir: target/docs
docs_dir: docs
repo_name: BetonQuest on GitHub
repo_url: https://github.com/BetonQuest/BetonQuest
edit_uri: edit/main/docs/
copyright: >
  <p id="bqCopyright">Auto Generated by _webCode/js/copyrightYearUpdater.js</p>
  <a href="#__consent">Change cookie settings</a>

extra_css:
  - '_webCode/css/button.css'
  - '_webCode/css/centered.css'
  - '_webCode/css/contentAreaFullWidth.css'
  - '_webCode/css/coloredIcons.css'
  - '_webCode/css/mermaidCentered.css'

extra_javascript:
  - '_webCode/js/copyLinkToClipboard.js'
  - '_webCode/js/copyrightYearUpdater.js'
  - '_webCode/js/mathjax.js'
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

# More info on this theme: https://squidfunk.github.io/mkdocs-material
theme:
  name: material
  custom_dir: 'docs/_custom_theme/'
  language: en
  features:
    - content.action.edit
    - content.code.annotate
    - content.code.copy
    - content.tabs.link
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.tracking
    - navigation.sections
    - navigation.top
    - navigation.path
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.progress
    - search.share
    - search.suggest
    - content.tooltips
    - toc.follow

  palette:
    - scheme: slate
      primary: indigo
      accent: teal
      toggle:
        icon: material/lightbulb
        name: Switch to light mode
    - scheme: default
      primary: blue
      accent: teal
      toggle:
        icon: fontawesome/solid/moon
        name: Switch to dark mode
  font:
    text: Roboto
    code: Roboto Mono
  logo: '_media/brand/Icon/Icon1K.png'
  favicon: '_media/brand/Icon/Icon32.ico'
  icon:
    admonition:
      example: fontawesome/regular/eye



# See the following for docs on these extensions: https://squidfunk.github.io/mkdocs-material/extensions
markdown_extensions:
  - admonition
  - attr_list
  - codehilite:
      linenums: true
  - footnotes
  - markdown.extensions.md_in_html
  - meta
  - pymdownx.highlight
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.keys
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      options:
        custom_icons:
          - '_custom_theme/.icons'
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - abbr
  - toc:
      permalink: 🔗

plugins:
  - search: { }
  - snippets:
      directory: "_snippets"
      identifier: "snippet"
  - exclude:
      glob:
        - _snippets/*
        - _custom_theme/*
        - _tutorials/*
  - group:
      enabled: !ENV MKDOCS_MATERIAL_INSIDERS_ENABLED
      plugins:
        - typeset
  - group:
      enabled: !ENV MKDOCS_MATERIAL_INSIDERS_ENABLED_CI
      plugins:
        - optimize

extra:
  version:
    provider: mike
    default:
      - RELEASE
      - DEV
  consent:
    title: Cookie consent
    cookies:
      github: GitHub
    actions:
      - manage
      - reject
      - accept
    description: >
      <p style="margin-top: 0px; margin-bottom: 0px;">We need your consent to make request to GitHub.com. We load statistics about our Git repository from there.</p>
      

  social:
    - icon: brands/discord
      link: https://discord.gg/rK6mfHq
    - icon: brands/opencollective
      link: https://opencollective.com/betonquest
    - icon: brands/modrinth
      link: https://modrinth.com/plugin/betonquest
    - icon: brands/spigot
      link: https://spigotmc.org/resources/2117/
    - icon: fontawesome/brands/github
      link: https://github.com/BetonQuest/BetonQuest
    - icon: brands/mail
      link: mailto://contact@betonquest.org

#Notice that here are a few strange looking hairspaces in here.
#They make the space between the emojis and the text look equal
nav:
  - 'Home': index.md
  - 'Tutorials':
      - 'Overview': Tutorials/Overview.md
      - 'Getting Started':
          - 'About': Tutorials/Getting-Started/About.md
          - 'Setup Guide':
              - 'Setting up a Test Server': Tutorials/Getting-Started/Setup-Guide/Setting-up-a-Test-Server.md
              - 'Installing BetonQuest': Tutorials/Getting-Started/Setup-Guide/Installing-BetonQuest.md
              - 'Setting up VSCode': Tutorials/Getting-Started/Setup-Guide/Setting-up-VSCode.md
          - 'Basics':
              - 'YAML': Tutorials/Getting-Started/Basics/YAML-Basics.md
              - 'Conversations': Tutorials/Getting-Started/Basics/Conversations.md
              - '    Events': Tutorials/Getting-Started/Basics/Events.md
              - 'Objectives': Tutorials/Getting-Started/Basics/Objectives.md
              - 'Conditions': Tutorials/Getting-Started/Basics/Conditions.md
      - 'Features':
          - 'Tracking Quest Progress':
              - 'Overview': Tutorials/Features/Tracking-Quest-Progress/Overview.md
              - 'Tags': Tutorials/Features/Tracking-Quest-Progress/Tags.md
      - 'Tools':
          - 'Handling YAML Errors': Tutorials/Tools/YAML-Errors.md
      - 'Syntax':
          - 'Quest Packages': Tutorials/Syntax/Quest-Packages.md
      - 'Frequently Asked Questions':
          - 'General FAQ': Tutorials/Frequently-Asked-Questions.md
  - 'Documentation':
      - 'Overview': Documentation/Overview.md

      - 'Scripting':
          - 'About Scripting': Documentation/Scripting/About-Scripting.md
          - 'Packages & Templates': Documentation/Scripting/Packages-&-Templates.md
          - 'Events List': Documentation/Scripting/Building-Blocks/Events-List.md
          - 'Objectives List': Documentation/Scripting/Building-Blocks/Objectives-List.md
          - 'Conditions List': Documentation/Scripting/Building-Blocks/Conditions-List.md
          - 'Integration List': Documentation/Scripting/Building-Blocks/Integration-List.md
          - 'Variables List': Documentation/Scripting/Building-Blocks/Variables-List.md
          - 'Additional Features':
              - 'Schedules': Documentation/Scripting/Schedules.md
              - 'Parties': Documentation/Scripting/Parties.md
              - 'Data Formats': Documentation/Scripting/Data-Formats.md
              - 'Quoting & advanced YAML': Documentation/Scripting/Quoting-&-YAML.md

      - 'Features':
          - 'Conversations': Documentation/Features/Conversations.md
          - 'Quest Menus':
              - 'Menus': Documentation/Features/Menus/Menu.md
              - 'Menu Example': Documentation/Features/Menus/Example.md
              - 'Elements': Documentation/Features/Menus/Elements.md
              - 'Menu Settings': Documentation/Features/Menus/Config.md
          - 'Additional Features':
              - 'Journal': Documentation/Features/Journal.md
              - 'Quest Items': Documentation/Features/Items.md
              - 'Quest Cancelers': Documentation/Features/Quest-Cancelers.md

      - 'Visual Effects':
          - 'Notifications':
              - 'Settings': Documentation/Visual-Effects/Notifications/Notification-Settings.md
              - "IO's & Categories": Documentation/Visual-Effects/Notifications/Notification-IO's-&-Categories.md
          - 'NPC Effects':
              - 'NPC Hiding': Documentation/Visual-Effects/NPC-Effects/NPC-Hiding.md
              - 'NPC Holograms': Documentation/Visual-Effects/NPC-Effects/NPC-Holograms.md
          - 'Additional Effects':
              - 'Quest Holograms': Documentation/Visual-Effects/Additional-Effects/Quest-Holograms.md
              - 'Player Hider': Documentation/Visual-Effects/Additional-Effects/Player-Hider.md

      - 'Configuration':
          - 'Configuration': Documentation/Configuration/Configuration.md
          - 'Permissions & Commands': Documentation/Configuration/Commands-and-permissions.md
          - 'Version Changes':
              - 'Updating': Documentation/Configuration/Version-Changes/Updating.md
              - 'Migration': Documentation/Configuration/Version-Changes/Migration.md
              - 'Changelog': Documentation/CHANGELOG.md
  - 'API':
      - 'Overview': API/Overview.md
      - 'Obtaining API': API/Obtaining-API.md
      - APIs:
          - 'Legacy API': API/Legacy-API.md
          - 'Logging': API/Logging.md
          - 'Configuration Files': API/ConfigurationFiles.md
          - 'Schedules': API/Schedules.md
  - 'Participate':
      - 'Overview': Participate/Overview.md
      - 'Donate Money': Participate/Donating-Money.md
      - 'Setup Project': Participate/Setup-Project.md
      - Process:
          - 'Create a new Branch': Participate/Process/Create-a-new-Branch.md
          - 'Changing Docs':
              - 'Workflow': Participate/Process/Docs/Workflow.md
              - 'Fundamental Principles': Participate/Process/Docs/Principles.md
              - 'Guidelines': Participate/Process/Docs/Guidelines.md
              - 'Writing Tutorials': Participate/Process/Docs/Writing-Tutorials.md
              - 'mkdocs Customizations': Participate/Process/Docs/Customizations.md
          - 'Changing Code':
              - 'Workflow': Participate/Process/Code/Workflow.md
              - 'Checking Requirements': Participate/Process/Code/Checking-Requirements.md
              - 'Adding a Dependency': Participate/Process/Code/Adding-a-new-Dependency.md
              - 'Writing JUnit Tests': Participate/Process/Code/Writing-JUnit-Tests.md
          - 'Maintaining the Changelog': Participate/Process/Maintaining-the-Changelog.md
          - 'Submitting Changes': Participate/Process/Submitting-Changes.md
      - Misc:
          - 'Versioning & Releasing': Participate/Misc/Versioning-and-Releasing.md
  - 'Downloads': Downloads/index.md

validation:
  nav:
    omitted_files: warn
    not_found: warn
    absolute_links: warn
  links:
    not_found: warn
    absolute_links: warn
    unrecognized_links: warn