mkdocs.yml

# Project information
site_name: AsBuiltReport
site_author: Tim Carman
site_description: AsBuiltReport is an open source configuration document framework which utilises Microsoft PowerShell to produce as-built documentation in multiple document formats for multiple vendors and technologies.
site_url: https://www.asbuiltreport.com
repo_name: asbuiltreport/asbuiltreport.core
repo_url: https://github.com/AsBuiltReport/AsBuiltReport.Core

# Copyright
copyright: Copyright © 2016 - 2026 Tim Carman

# Configuration
theme:
    name: material
    language: en
    logo: assets/images/logos/AsBuiltReport.png
    favicon: assets/images/logos/AsBuiltReport.png
    features:
      - content.action.edit
      - content.action.view
      - content.code.annotate
      - navigation.tabs
      - navigation.tabs.sticky
      - navigation.top
      - navigation.sections
      - navigation.indexes
      - navigation.footer
      - navigation.tracking
      - content.code.copy
      - search.highlight
    palette:
      primary: amber
      accent: blue
    locale: en
    highlightjs: true

# Customization
extra:
  analytics:
    provider: google
    property: !ENV GOOGLE_ANALYTICS_KEY
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/AsBuiltReport
      name: AsBuiltReport on GitHub
    - icon: fontawesome/brands/bluesky
      link: https://bsky.app/profile/asbuiltreport.com
      name: AsBuiltReport on Bluesky
    - icon: fontawesome/brands/x-twitter
      link: https://x.com/AsBuiltReport
      name: AsBuiltReport on X (Twitter)
  generator: false

extra_css:
  - assets/stylesheets/extra.css

# Plugins
plugins:
  - search:
      lang: en
      separator: '[\s\-\.]+'
  - git-revision-date-localized:
      enable_creation_date: false
      fallback_to_build_date: true
  - blog:
      blog_dir: blog
      post_dir: blog/posts
      archive: false
      blog_toc: false
      post_date_format: medium
      draft: false
      draft_on_serve: true
      draft_if_future_date: true
  - rss:
      match_path: blog/posts/.*
      date_from_meta:
        as_creation: date
        default_time: "09:00"
      categories:
        - categories
        - tags
  - social:
      cards_layout_options:
        font_family: Montserrat Alternates
        color: "#063561"
  - redirects:
      redirect_maps:
        'about/contributing.md': 'dev-guide/contributing.md'
        'about/acknowledgements.md': 'about/contributors.md'
        'user-guide/known-issues.md': 'support/known-issues.md'

# Extensions
markdown_extensions:
  - attr_list
  - admonition
  - meta
  - tables
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      auto_title: true
      use_pygments: true
  - md_in_html
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      toc_depth: 3

# Page Navigation
nav:
  - Home: index.md
  - User Guide:
    - Getting Started:
      - Quickstart: user-guide/quickstart.md
      - Installation: user-guide/installation.md
      - Best Practices: user-guide/best-practices.md
    - Commands:
      - New-AsBuiltConfig: user-guide/new-asbuiltconfig.md
      - New-AsBuiltReport: user-guide/new-asbuiltreport.md
      - New-AsBuiltReportConfig: user-guide/new-asbuiltreportconfig.md
    - Report Modules:
      - user-guide/report-modules/overview.md
      - Aruba:
        - Aruba ClearPass: https://github.com/AsBuiltReport/AsBuiltReport.Aruba.ClearPass#readme
      - Dell EMC:
        - Dell EMC VxRail: https://github.com/AsBuiltReport/AsBuiltReport.DellEMC.VxRail#readme
      - Fortinet:
        - Fortinet FortiGate: https://github.com/AsBuiltReport/AsBuiltReport.Fortinet.FortiGate#readme
      - Microsoft:
        - Microsoft Active Directory: https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.AD#readme
        - Microsoft Azure: https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.Azure#readme
        - Microsoft DHCP: https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.DHCP#readme
        - Microsoft SCVMM: https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.SCVMM#readme
        - Microsoft Windows: https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.Windows#readme
      - NetApp:
        - NetApp ONTAP: https://github.com/AsBuiltReport/AsBuiltReport.NetApp.ONTAP#readme
      - Nutanix:
        - Nutanix Prism Element: https://github.com/AsBuiltReport/AsBuiltReport.Nutanix.PrismElement#readme
      - Pure Storage:
        - Pure Storage FlashArray: https://github.com/AsBuiltReport/AsBuiltReport.PureStorage.FlashArray#readme
      - Rubrik:
        - Rubrik CDM: https://github.com/AsBuiltReport/AsBuiltReport.Rubrik.CDM#readme
      - Veeam:
        - Veeam VB365: https://github.com/AsBuiltReport/AsBuiltReport.Veeam.VB365#readme
        - Veeam VBR: https://github.com/AsBuiltReport/AsBuiltReport.Veeam.VBR#readme
      - VMware:
        - VMware App Volumes: https://github.com/AsBuiltReport/AsBuiltReport.VMware.AppVolumes#readme
        - VMware ESXi: https://github.com/AsBuiltReport/AsBuiltReport.VMware.ESXi#readme
        - VMware Horizon: https://github.com/AsBuiltReport/AsBuiltReport.VMware.Horizon#readme
        - VMware Site Recovery Manager: https://github.com/AsBuiltReport/AsBuiltReport.VMware.SRM#readme
        - VMware vSphere: https://github.com/AsBuiltReport/AsBuiltReport.VMware.vSphere#readme
  - Developer Guide:
    - dev-guide/contributing.md
    - Creating a report module: dev-guide/creating-a-report-module.md
    - Creating a report style: dev-guide/creating-a-report-style.md
  - Support:
    - FAQ: support/faq.md
    - Troubleshooting: support/troubleshooting.md
    - Known Issues: support/known-issues.md
    - Discussion Board: https://github.com/orgs/AsBuiltReport/discussions
    - Donate: support/donate.md
  - Blog:
    - blog/index.md
  - About:
    - Contributors: about/contributors.md
    - Contact: about/contact.md
    - License: about/license.md