mkdocs.yml

# Project Information
site_name: VMware.CloudFoundation.PowerManagement
site_description: PowerShell Module for VMware Cloud Foundation Power Management
site_url: https://vmware.github.io/powershell-module-for-vmware-cloud-foundation-power-management
site_author: Broadcom
docs_dir: docs
site_dir: .site
use_directory_urls: true

# Repository
repo_url: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-power-management
edit_uri: blob/main/docs/

# Copyright
copyright: |
  Copyright &copy; 2005-2024 Broadcom. All Rights Reserved.<br/>
  The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries.<br/><br/>

# Configuration
theme:
  name: material
  favicon: favicon.ico
  logo: assets/images/icon-white.svg
  icon:
    repo: fontawesome/brands/github
  palette:
  - media: "(prefers-color-scheme: light)"
    scheme: default
    primary: indigo
    accent: indigo
    toggle:
      icon: material/toggle-switch
      name: Dark Theme
  - media: "(prefers-color-scheme: dark)"
    scheme: slate
    primary: indigo
    accent: indigo
    toggle:
      icon: material/toggle-switch-off-outline
      name: Light Theme
  font:
    text: Roboto
    code: Roboto Mono
  features:
  - content.action.edit
  - content.action.view
  - content.code.annotate
  - content.code.copy
  - content.tabs.link
  - navigation.expand
  - navigation.footer
  - navigation.header
  - navigation.indexes
  - navigation.instant
  - navigation.tabs
  - navigation.tabs.sticky
  - navigation.top
  - navigation.tracking
  - search.highlight
  - search.share
  - search.suggest
  - toc.follow

# Plugins
plugins:
- search:
    separator: '[\s\u200b\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
- open-in-new-tab
- markdownextradata:
    jinja_options:
      variable_start_string: "${{"
      variable_end_string: "}}"
- git-revision-date-localized:
    enabled: !ENV [CI, false]
    enable_creation_date: false
    exclude:
      - index.md
    fallback_to_build_date: true
    type: timeago

# Customization
extra:
  config:
    repo_url: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-power-management
    repo_url_raw: https://raw.githubusercontent.com/vmware/powershell-module-for-vmware-cloud-foundation-power-management
  version:
    default: latest
    provider: mike
extra_css:
  - assets/stylesheets/extra.css

# Extensions
markdown_extensions:
- admonition
- attr_list
- md_in_html
- pymdownx.emoji:
    emoji_index: !!python/name:material.extensions.emoji.twemoji
    emoji_generator: !!python/name:material.extensions.emoji.to_svg
    options:
      custom_icons:
      - material/.icons
- pymdownx.inlinehilite
- pymdownx.highlight:
    use_pygments: true
- pymdownx.snippets:
    check_paths: true
- pymdownx.superfences:
    custom_fences:
    - name: mermaid
      class: mermaid
      format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
    alternate_style: true
- pymdownx.details
- tables
- toc:
    permalink: true

# Navigation
nav:
- Getting Started:
  - index.md
  - Installation: documentation/getting-started/install.md
  - Updating: documentation/getting-started/update.md
  - User Access: documentation/getting-started/user-access.md
  - Usage: documentation/getting-started/usage.md
  - Limitations: documentation/getting-started/limitations.md
  - Known Issues: documentation/getting-started/known-issues.md
  - Troubleshooting: documentation/getting-started/troubleshooting.md
  - Release Notes: release-notes.md
  - Release Milestones: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-power-management/milestones
  - License: license.md
- Reference:
  - documentation/index.md
  - Functions:
    - Get-DrsAutomationLevel: documentation/functions/Get-DrsAutomationLevel.md
    - Get-EdgeNodeFromNSXManager: documentation/functions/Get-EdgeNodeFromNSXManager.md
    - Get-MaintenanceMode: documentation/functions/Get-MaintenanceMode.md
    - Get-NSXTComputeManagers: documentation/functions/Get-NSXTComputeManagers.md
    - Get-poweronVMsOnRemoteDS: documentation/functions/Get-poweronVMsOnRemoteDS.md
    - Get-SSHEnabledStatus: documentation/functions/Get-SSHEnabledStatus.md
    - Get-TanzuEnabledClusterStatus: documentation/functions/Get-TanzuEnabledClusterStatus.md
    - Get-VamiServiceStatus: documentation/functions/Get-VamiServiceStatus.md
    - Get-VMRunningStatus: documentation/functions/Get-VMRunningStatus.md
    - Get-VMsWithPowerStatus: documentation/functions/Get-VMsWithPowerStatus.md
    - Get-VMToClusterMapping: documentation/functions/Get-VMToClusterMapping.md
    - Invoke-EsxCommand: documentation/functions/Invoke-EsxCommand.md
    - Invoke-VxrailClusterShutdown: documentation/functions/Invoke-VxrailClusterShutdown.md
    - Set-DrsAutomationLevel: documentation/functions/Set-DrsAutomationLevel.md
    - Set-MaintenanceMode: documentation/functions/Set-MaintenanceMode.md
    - Set-Retreatmode: documentation/functions/Set-Retreatmode.md
    - Set-VamiServiceStatus: documentation/functions/Set-VamiServiceStatus.md
    - Set-VsanClusterPowerStatus: documentation/functions/Set-VsanClusterPowerStatus.md
    - Set-VsphereHA: documentation/functions/Set-VsphereHA.md
    - Start-CloudComponent: documentation/functions/Start-CloudComponent.md
    - Stop-CloudComponent: documentation/functions/Stop-CloudComponent.md
    - Test-LockdownMode: documentation/functions/Test-LockdownMode.md
    - Test-VsanHealth: documentation/functions/Test-VsanHealth.md
    - Test-VsanObjectResync: documentation/functions/Test-VsanObjectResync.md
    - Wait-ForStableNsxtClusterStatus: documentation/functions/Wait-ForStableNsxtClusterStatus.md
- Community:
  - community/index.md
  - Contributing: community/contributing.md
  - Discussions: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-power-management/discussions
  - Search Issues: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-power-management/issues
  - Open an Issue: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-power-management/issues/new/choose
  - Support: community/support.md
  - Code of Conduct: community/code-of-conduct.md