mkdocs.yml

site_name: UI5 Tooling
site_url: 'https://sap.github.io/ui5-tooling/' # required for working 404 page
repo_name: 'SAP/ui5-tooling'
repo_url: 'https://github.com/SAP/ui5-tooling'
edit_uri: ./edit/main/docs # default points to "master" branch
docs_dir: 'docs' # default
site_dir: 'site' # default
copyright: '© Copyright 2024, SAP SE and UI5 Tooling Contributors'
nav:
    - Home: index.md
    - Getting Started: pages/GettingStarted.md
    - UI5 CLI: pages/CLI.md
    - Configuration: pages/Configuration.md
    - Development:
      - Overview: pages/Overview.md
      - OpenUI5: pages/OpenUI5.md
      - SAPUI5: pages/SAPUI5.md
      - Workspace: pages/Workspace.md
    - Extensibility:
      - Custom Tasks: pages/extensibility/CustomTasks.md
      - Custom Server Middleware: pages/extensibility/CustomServerMiddleware.md
      - Project Shims: pages/extensibility/ProjectShims.md
    - Modules:
      - Server: pages/Server.md
      - Builder: pages/Builder.md
      - Project: pages/Project.md
      - File System: pages/FileSystem.md
    - Upgrade Guides:
      - Migrate to v4: updates/migrate-v4.md
      - Migrate to v3: updates/migrate-v3.md
      - Migrate to v2: updates/migrate-v2.md
      - Migrate to v1: updates/migrate-v1.md
    - FAQ: pages/FAQ.md
    - Miscellaneous:
      - Troubleshooting: pages/Troubleshooting.md
      - Benchmarking: pages/Benchmarking.md
      - ECMAScript Support: pages/ESSupport.md
      - Code Analysis: pages/CodeAnalysis.md
    - API Reference: 'api/index.html' # only available in final build, not serve

theme:
  name: 'material'
  custom_dir: 'overrides'
  palette:
    primary: 'blue'
    accent: 'blue'
  logo: 'images/logo.svg'
  favicon: 'images/favicon.png'
  font: false
  features:
    - navigation.expand

extra_css:
  - 'stylesheets/extra.css'

extra:
  version:
    provider: mike

plugins:
  - search
  - minify:
      minify_html: true
  - mike:
      canonical_version: null
      version_selector: true
      css_dir: stylesheets
      javascript_dir: js

markdown_extensions:
  - admonition
  - attr_list
  - codehilite:
      guess_lang: false
  - toc:
      permalink: true
  # PyMdown Extensions Documentation: https://facelessuser.github.io/pymdown-extensions/extensions/betterem/
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.details
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.keys
  - pymdownx.smartsymbols
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.superfences
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - pymdownx.caret