mkdocs.yml

site_name: GroovyScript

repo_name: CleanroomMC/GroovyScript-Docs
repo_url: https://github.com/CleanroomMC/GroovyScript-Docs

nav:
  - Introduction: introduction/
  - Groovy: groovy/
  - GroovyScript: groovyscript/

theme:
  name: material
  palette:
    - scheme: slate
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    - scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

  custom_dir: overrides

  features:
    - content.code.annotate
    - content.code.copy
    - content.action.edit
    - content.action.view

    #- navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.top
    - navigation.indexes
    - navigation.prune
    - navigation.footer

    - search.suggest
    - search.highlight

    - announce.dismiss

extra:
  social:
    - icon: fontawesome/solid/code
      link: https://github.com/CleanroomMC/GroovyScript
      name: GroovyScript Source Code
    - icon: fontawesome/regular/file
      link: https://github.com/CleanroomMC/GroovyScript-Docs
      name: GroovyScript Docs Source Code
    - icon: custom/curseforge
      link: https://www.curseforge.com/minecraft/mc-mods/groovyscript
      name: Download GroovyScript on Curseforge
    - icon: fontawesome/brands/discord
      link: https://discord.com/invite/m53yxTjjKM
      name: Join the Cleanroom Discord

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - attr_list
  - def_list
  - md_in_html
  - footnotes
  - tables
  - toc
  - toc:
      permalink: "#"

plugins:
  - search
  - literate-nav:
      nav_file: "!navigation.md"
  - git-revision-date-localized:
      enable_creation_date: true
      type: timeago
      enabled: !ENV [CI, false]

extra_css:
  - stylesheets/extra.css

validation:
  nav:
    omitted_files: info
    not_found: info
    absolute_links: info
  links:
    absolute_links: info
    not_found: info
    unrecognized_links: ignore