mkdocs.yml

site_name: BetonQuest
site_author: BetonQuest Organisation
site_url: https://docs.betonquest.org/
site_dir: target/docs
docs_dir: docs
repo_name: BetonQuest on GitHub
repo_url: https://github.com/BetonQuest/BetonQuest
copyright: 'Auto Generated by _webCode/js/copyrightYearUpdater.js'

extra_css:
  - '_webCode/css/button.css'
  - '_webCode/css/centered.css'
  - '_webCode/css/contentAreaFullWidth.css'
  - '_webCode/css/coloredIcons.css'
  - '_webCode/css/ExternalLinkIcon.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.code.annotate
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.tracking
    - navigation.sections
    - navigation.top
    - search.share
    - navigation.indexes
    - search.suggest
    - content.tooltips
  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:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.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
  - pymdownx.snippets:
      base_path: docs/_snippets
  - abbr
  - toc:
      permalink: 🔗

plugins:
  - search
  - exclude:
      glob:
        - _snippets/*
        - _custom_theme/*

extra:
  version:
    provider: mike
  analytics:
    provider: google
    property: G-VEBGTNXWEL
    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="https://github.com/BetonQuest/BetonQuest/issues/new/?template=docs-feedback.yml&title=[Docs Feedback]+{title}+-+{url}&version=%VERSION%">
            feedback form</a>.
  consent:
    title: Cookie consent
    cookies:
      analytics: Google Analytics
    actions:
      - manage
      - reject
      - accept
    description: >
      <p style="margin-top: 0px; margin-bottom: 0px;">We use cookies to:</p>
      <ul style="margin-top: 0px; margin-bottom: 0px;">
        <li>
          <p>Save your preferences (light / dark mode etc.)</p>
        </li>
        <p style="margin-top: 0px; margin-bottom: 0px;">Additionally, you can allow us to:</p>
        <li>
          <p>Measure the effectiveness of our documentation</p>
        </li>
        <li>
          <p>See if users find what they're searching for.</p>
        </li>
      </ul>
      <b>With your consent, you're helping us to make this documentation better for everyone.</b>
  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: material/file-download
      link: https://dev.betonquest.org
    - 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
          - 'Basics':
              - 'YAML': Tutorials/Getting-Started/Basics/YAML.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
      - 'Tools':
          - 'Setting up VSCode': Tutorials/Tools/Setting-up-VSCode.md
      - 'Syntax':
          - 'Quest Packages': Tutorials/Syntax/Quest-Packages.md
      - 'Frequently Asked Questions':
          - 'General FAQ': Tutorials/Frequently-Asked-Questions.md
  - 'Documentation':
      - 'General':
          - 'Conversations': Documentation/Conversations.md
          - 'Items': Documentation/Items.md
          - 'Journal': Documentation/Journal.md
          - 'Parties': Documentation/Parties.md
          - 'Player Hider': Documentation/Player-Hider.md
          - 'Quest Cancelers': Documentation/Quest-Cancelers.md
          - 'Data Formats': Documentation/Data-Formats.md
          - 'Packages & Templates': Documentation/Packages-&-Templates.md
      - 'Types':
          - 'About Types': Documentation/About-Types.md
          - 'Objectives List': Documentation/Objectives-List.md
          - 'Events List': Documentation/Events-List.md
          - 'Conditions List': Documentation/Conditions-List.md
          - 'Compatibility List': Documentation/Compatibility.md
          - 'Variables List': Documentation/Variables-List.md
          - 'Schedules': Documentation/Schedules.md
      - 'Notifications':
          - 'Settings': Documentation/Notification-Settings.md
          - "IO's & Categories": Documentation/Notification-IO's-&-Categories.md
      - 'Menus':
          - 'Menus': Documentation/Menu-Menu.md
          - 'Menu Example': Documentation/Menu-Example.md
          - 'Elements': Documentation/Menu-Elements.md
          - 'Config': Documentation/Menu-Config.md
      - 'Technical':
          - 'Permissions & Commands': Documentation/Commands-and-permissions.md
          - 'Updating': Documentation/Updating.md
          - 'Migration': Documentation/Migration.md
          - 'Configuration': Documentation/Configuration.md
          - 'Changelog': Documentation/CHANGELOG.md
  - 'API':
      - 'Overview': API/Overview.md
      - 'Legacy API': API/API.md
      - 'ConfigurationFile': API/ConfigurationFile.md
      - 'Logging': API/Logging.md
      - 'Schedules': API/Schedules.md
  - 'Participate':
      - 'Overview': Participate/Overview.md
      - 'Setup Project': Participate/Setup-Project.md
      - Process:
          - 'Create a new Branch': Participate/Process/Create-a-new-Branch.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
          - 'Changing Docs':
              - 'Workflow': Participate/Process/Docs/Workflow.md
              - 'Fundamental Principles': Participate/Process/Docs/Principles.md
              - 'Guidelines': Participate/Process/Docs/Guidelines.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