mkdocs.yml

# Project Information
site_name: VMware.CloudFoundation.CertificateManagement
site_description: PowerShell Module for VMware Cloud Foundation Certificate Management
site_url: https://vmware.github.io/powershell-module-for-vmware-cloud-foundation-certificate-management
site_author: VMware, Inc.
docs_dir: docs
site_dir: .site
use_directory_urls: true

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

# Copyright
copyright: Copyright © 2023 - VMware, Inc.

# 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.footer
  - navigation.header
  - navigation.indexes
  - navigation.instant
  - navigation.sections
  - 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-authors
- 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-certificate-management
    repo_url_raw: https://raw.githubusercontent.com/vmware/powershell-module-for-vmware-cloud-foundation-certificate-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:materialx.emoji.twemoji
    emoji_generator: !!python/name:materialx.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: install.md
  - Updating: update.md
  - User Access: user-access.md
  - Release Notes: release-notes.md
  - Release Milestones: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-certificate-management/milestones
  - License: license.md
- Reference:
  - User Guide:
    - VMware Cloud Foundation Certificate Management: documentation/user-guide/vcf-certificate-management.md
    - ESXi Certificate Management: documentation/user-guide/esxi-certificate-management.md
  - Functions:
    - Common: 
      - Get-VCFCertificateThumbprint: documentation/functions/Get-VCFCertificateThumbprint.md
      - Install-VCFCertificate: documentation/functions/Install-VCFCertificate.md
      - Request-VCFCsr: documentation/functions/Request-VCFCsr.md
    - VMware Cloud Foundation Certificate Management:
      - Request-VCFSignedCertificate: documentation/functions/Request-VCFSignedCertificate.md
      - Set-VCFCertificateAuthority: documentation/functions/Set-VCFCertificateAuthority.md
    - ESXi Certificate Management:
      - Confirm-CAInvCenterServer: documentation/functions/Confirm-CAInvCenterServer.md
      - Confirm-EsxiCertificateInstalled: documentation/functions/Confirm-EsxiCertificateInstalled.md
      - Get-EsxiCertificateMode: documentation/functions/Get-EsxiCertificateMode.md
      - Get-EsxiLockdownMode: documentation/functions/Get-EsxiLockdownMode.md
      - Get-vSANHealthSummary: documentation/functions/Get-vSANHealthSummary.md
      - Restart-EsxiHost: documentation/functions/Restart-EsxiHost.md
      - Set-EsxiCertificateMode: documentation/functions/Set-EsxiCertificateMode.md
      - Set-EsxiLockdownMode: documentation/functions/Set-EsxiLockdownMode.md
      - Test-EsxiCertMgmtChecks: documentation/functions/Test-EsxiCertMgmtChecks.md
- Community:
  - community/index.md
  - Contributing: community/contributing.md
  - Discussions: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-certificate-management/discussions
  - Search Issues: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-certificate-management/issues
  - Open an Issue: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-certificate-management/issues/new/choose
  - Support: community/support.md
  - Code of Conduct: community/code-of-conduct.md