mkdocs.yml

# https://www.mkdocs.org/user-guide/configuration/

# Project information
site_name: 'AWS Tools for VMware'
site_description: 'Tools and sample code primarily intended for VMware Cloud on AWS.'
site_author: 'Amazon Web Services, Inc.'
site_url: 'https://awslabs.github.io/aws-tools-for-vmware/'

# Repository
repo_name: 'aws-tools-for-vmware'
repo_url: 'https://github.com/awslabs/aws-tools-for-vmware'
remote_branch: 'gh-pages'
edit_uri: 'blob/main/docs/'

# Copyright
copyright: 'Copyright © 2019 - 2022, Amazon Web Services, Inc. or its affiliates. All rights reserved.'

# Configuration
theme:
  name: 'material'

  # 404 page
  static_templates:
    - '404.html'

  # Don't include MkDocs' JavaScript
  include_search_page: false
  search_index_only: true

  # Theme
  language: 'en'
  features:
    - content.code.annotate
    # - content.tabs.link
    # - header.autohide
    # - navigation.expand
    - navigation.indexes
    - navigation.instant
    # - navigation.sections
    # - navigation.tabs
    # - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    # - toc.integrate
  font: false
  icon:
    logo: 'material/home'
    repo: 'fontawesome/brands/github'

extra_css:
  - stylesheets/extra.css

# Plugins
plugins:
  - search

# Customization
extra:
  social:
    - icon: 'fontawesome/brands/aws'
      link: 'https://aws.amazon.com/vmware/'
    - icon: 'fontawesome/brands/github-alt'
      link: 'https://github.com/awslabs/aws-tools-for-vmware'
    - icon: 'fontawesome/brands/twitter'
      link: 'https://twitter.com/AWSOpen'
    - icon: 'fontawesome/brands/reddit-alien'
      link: 'https://www.reddit.com/r/aws/'

# Extensions
markdown_extensions:
  - admonition
  - abbr
  - attr_list
  - def_list
  - footnotes
  - meta
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: awslabs
      repo: aws-sync-routes
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

# Page tree
nav:
  - Home: 'index.md'
  - PowerShell:
    - Upgrade SQL Server Standalone Database Engine Instance: 'powershell/Upgrade-SqlServerStandaloneDatabaseEngineInstance.ps1.md'
  - Terraform:
    - Deploy x number of shell VMs in VMware Cloud on AWS: 'terraform/Deploy-XNumShellVMs.md'
  - About:
    - Contributing Guidelines: 'about/contributing.md'
    - License: 'about/license.md'