mkdocs.yml

# Project information
site_name: Arista AVD collection
site_author: Arista Ansible Team
site_description: Arista Validated Design collection's documentation
copyright: Copyright © 2019 - 2020 Arista Networks

# Repository information
repo_name: AVD on Github
repo_url: https://github.com/aristanetworks/ansible-avd

# Configuration
use_directory_urls: true
theme:
  name: material
  custom_dir: ansible_collections/arista/avd/docs/_overrides
  features:
    - navigation.instant
    - navigation.top
  highlightjs: true
  hljs_languages:
    - yaml
    - python
    - shell
  icon:
    repo: fontawesome/brands/github
    logo: fontawesome/solid/book
  favicon: docs/_media/favicon.ico
  font:
    code: Fira Mono
  language: en
  include_search_page: false
  search_index_only: true

extra_css:
  - docs/stylesheets/extra.material.css

plugins:
  - search:
      lang: en
  - git-revision-date-localized:
      type: date
  - minify:
      minify_html: true
  #     minify_js: true

markdown_extensions:
  - mdx_truly_sane_lists
  - smarty
  - pymdownx.arithmatex
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - fontawesome_markdown
  - admonition
  - codehilite:
      guess_lang: true
  - toc:
      separator: "-"
      # permalink: "#"
      permalink: true
      baselevel: 3
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.snippets:
      base_path: 'ansible_collections/arista/avd/'

# TOC
docs_dir: ansible_collections/arista/avd/
nav:
  - Home: README.md
  - Release Notes:
      - 2.x.x: docs/release-notes/2.x.x.md
      - 1.1.x: docs/release-notes/1.1.x.md
      - 1.0.x: docs/release-notes/1.0.x.md
  - Getting Started: docs/getting-started.md
  - Installation:
      - Requirements: docs/installation/requirements.md
      - Setup environment: docs/installation/setup-environment.md
      - Ansible-galaxy installation: docs/installation/setup-galaxy.md
      - Git installation: docs/installation/setup-git.md
      - Development tips & tricks: docs/installation/development.md
  - How-To:
      - Build your first AVD project: docs/how-to/first-project.md
      - Build your first AVD & CVP project: docs/how-to/first-cvp-avd-project.md
      - Use NAT to access eAPI: docs/how-to/lab-with-nat.md
      - AWX & Tower Integration: docs/how-to/tower-integration.md
      - Configure ZTP server with CV collection: docs/how-to/ztp.md
      - VScode Container: docs/how-to/vscode-container.md
  - Roles documentation:
    - eos_designs:
      - Overview: roles/eos_designs/README.md
      - l3ls-evpn:
        - Overview: roles/eos_designs/doc/l3ls-evpn.md
        - Common Settings: roles/eos_designs/doc/l3ls-evpn/common-settings.md
        - Fabric Topology: roles/eos_designs/doc/l3ls-evpn/fabric-topology.md
        - Fabric Variables: roles/eos_designs/doc/l3ls-evpn/fabric-variables.md
        - Network Services: roles/eos_designs/doc/l3ls-evpn/network-services.md
        - Connected Endpoints: roles/eos_designs/doc/common/connected-endpoints.md
        - DCI & L3 Edge: roles/eos_designs/doc/common/l3-edge.md
    - eos_cli_config_gen: roles/eos_cli_config_gen/README.md
    - cvp_configlet_upload: roles/cvp_configlet_upload/README.md
    - eos_config_deploy_cvp: roles/eos_config_deploy_cvp/README.md
    - eos_config_deploy_eapi: roles/eos_config_deploy_eapi/README.md
    - eos_validate_state: roles/eos_validate_state/README.md
    - eos_snapshot: roles/eos_snapshot/README.md
    - dhcp_provisioner: roles/dhcp_provisioner/README.md
    - build_output_folders: roles/build_output_folders/README.md
    - upgrade_tools: roles/upgrade_tools/README.md
  - Modules documentation:
      - Module Inventory to containers: docs/modules/inventory_to_container.rst.md
      - Module Configlet Build configuration: docs/modules/configlet_build_config.rst.md
      - AVD Plugins & Filters: plugins/README.md
      - Cloudvision Module documentation: https://cvp.avd.sh/
  - External resources:
      - Ansible collection user guide: https://docs.ansible.com/ansible/latest/user_guide/collections_using.html
      - Ansible User guide: https://docs.ansible.com/ansible/latest/user_guide/index.html
  - About:
      - Contribution Guide: docs/contributing.md
      - Ansible Galaxy page: https://galaxy.ansible.com/arista/avd
      - Arista CVP Collection: https://cvp.avd.sh/en/latest/
      - Arista Installation Script: https://github.com/arista-netdevops-community/avd-install
      - Arista Netdevops Community: https://aristanetworks.github.io/netdevops-examples/