mkdocs.yml

site_name: GradleUp
site_description: >-
  GradleUp is an umbrella GitHub organization focusing
  on simplifying Java, Kotlin and Android development with Gradle.
  On our menu: Gradle plugins, developer tools and best practices.
copyright: >-
  Copyright © 2024 - GradleUp contributors.
  The content and the license are licensed under CC BY 4.0.
  Gradle and the Gradlephant logo (the "Gradle Marks") are registered trademarks of Gradle, Inc. and/or its subsidiaries.
  In the GradleUp organization, "Gradle" typically means "Gradle Build Tool" and does not reference Gradle Inc. and/or its subsidiaries. 
repo_url: https://github.com/GradleUp/gradleup.github.io
repo_name: GitHub Repo
edit_uri: edit/main/
site_url: https://www.gradleup.com

# Build
site_dir: _site
docs_dir: .

nav:
  - Projects:
    - All Projects: projects/README.md
    - Gradle Plugins:
      - Auto Manifest: auto-manifest/README.md
      - Gradle static analysis plugin: static-analysis-plugin/README.md
      - Gratatouille: gratatouille/README.md
      - Gr8: gr8/README.md
      - Librarian: librarian/README.md
      - Maven Sympathy: maven-sympathy/README.md
      - NMCP (New Maven Central Publishing): nmcp/README.md
      - Shadow: shadow/README.md
    - Hosting New Projects: docs/community/hosting.md
  - Participate:
    - Community Channels: docs/community/participate.md
    - GradleUp Team: docs/community/team.md
    - Hosting New Projects: docs/community/hosting.md
    - Contributing to the Website: ./CONTRIBUTING.md
    - Governance: docs/community/governance.md
    - Code of Conduct: org/CODE_OF_CONDUCT.md
  - Blog: https://blog.gradleup.com/
  - Resources:
    - Community Support: org/SUPPORT.md
    - Security Policy: org/SECURITY.md
    - Code of Conduct: org/CODE_OF_CONDUCT.md

plugins:
  - search
  - autorefs
  - macros
  - mkdocs-pdf
  - social:
      cards_layout_options:
        background_color: "#2A465B"
  - same-dir
  - group:
      enabled: !ENV [FULL_BUILD, true]
      plugins:
      - multirepo:
          cleanup: false
          keep_docs_dir: true
          nav_repos:
          - name: org
            import_url: 'https://github.com/gradleup/.github?branch=main&edit_uri=/blob/main/'
            imports: [ '*.md' ]

          # Projects
          - name: gratatouille
            import_url: 'https://github.com/GradleUp/gratatouille?branch=main&edit_uri=/blob/main/'
            imports: [ README.md ]
          - name: auto-manifest
            import_url: 'https://github.com/GradleUp/auto-manifest?branch=master&edit_uri=/blob/master/'
            imports: [ README.md ]
          - name: nmcp
            import_url: 'https://github.com/GradleUp/nmcp?branch=main&edit_uri=/blob/main/'
            imports: [ README.md ]
          - name: librarian
            import_url: 'https://github.com/GradleUp/librarian?branch=main&edit_uri=/blob/main/'
            imports: [ README.md ]
          - name: maven-sympathy
            import_url: 'https://github.com/GradleUp/maven-sympathy?branch=main&edit_uri=/blob/main/'
            imports: [ README.md ]
          - name: gr8
            import_url: 'https://github.com/GradleUp/gr8?branch=main&edit_uri=/blob/main/'
            imports: [ README.md, CONTRIBUTING.md ]
          - name: static-analysis-plugin
            import_url: 'https://github.com/GradleUp/static-analysis-plugin?branch=master&edit_uri=/blob/master/'
            imports: [ README.md, CHANGELOG.md, LICENSE, 'docs/**' ]
          - name: shadow
            import_url: 'https://github.com/GradleUp/shadow?branch=main&edit_uri=/blob/main/'
            imports: [ README.md ]
  - redirects:
      redirect_maps:

# Markdown
markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: '#'
  - attr_list
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - mdx_truly_sane_lists

# Theme
theme:
  custom_dir: overrides
  name: material
  highlightjs: true
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.code.select
    - content.tabs.link
    - content.tooltips
    # - header.autohide
    # - navigation.expand
    - navigation.footer
    # NOT compatible qith toc.integrate
    # - navigation.indexes
    - navigation.path
    # - navigation.instant
    # - navigation.instant.prefetch
    # - navigation.instant.progress
    # - navigation.prune
    - navigation.sections
    - navigation.expand
    - navigation.tabs
    # - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    - toc.integrate
  palette:
    - scheme: default
      media: "(prefers-color-scheme: light)"
      primary: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      media: "(prefers-color-scheme: dark)"
      primary: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: DM Sans
    code: Roboto Mono
  favicon: assets/images/logo-square.svg
  logo: assets/images/logo.svg
  icon:
    repo: fontawesome/brands/github

extra_css:
  - assets/css/theme.css

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/GradleUp
      name: GitHub
    - icon: fontawesome/brands/slack
      link: https://gradleup.com/docs/community/participate/#slack
      name: Slack
    - icon: /fontawesome/solid/blog
      link: https://blog.gradleup.com
      name: Blog
    - icon: /fontawesome/solid/rss
      link: https://blog.gradleup.com/rss.xml
      name: Blog - RSS

#  analytics:
#    provider: google
#    property: TODO