mkdocs.yml

# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.

site_name: PSRule
site_url: https://microsoft.github.io/PSRule
site_description: Validate infrastructure as code (IaC) and objects using PowerShell rules.
site_author: Microsoft

repo_url: https://github.com/microsoft/PSRule
edit_uri: blob/main/docs/

extra_css:
  - assets/stylesheets/extra.css

theme:
  language: en
  name: material
  custom_dir: overrides
  font:
    text: Roboto
  palette:
    primary: black
    accent: blue
  logo: assets/ms_icon.png
  favicon: assets/ms_icon.png
  icon:
    repo: fontawesome/brands/github
  features:
    - navigation.instant
    - navigation.indexes
    - navigation.sections:
        level: 1
    - navigation.tabs
    - navigation.footer
    - content.code.annotate
    - content.tabs.link
    - content.code.copy
    - content.action.edit
    - content.action.view

nav:
  - Home: index.md
  - Getting started:
      - Overview:
          - About: about.md
          - Features: features.md
      - Setup:
          - Index: setup/index.md
          - Visual Studio Code: setup/vscode.md
      - Quickstarts:
          - Create a standalone rule: quickstart/standalone-rule.md
      - User guide:
          - Creating your pipeline: creating-your-pipeline.md
          - Validating locally: validating-locally.md
          - Analysis output: analysis-output.md
      - Developer guide:
          - Testing infrastructure: authoring/testing-infrastructure.md
          - Using expressions: authoring/using-expressions.md
          - Storing and naming rules: authoring/storing-rules.md
          - Packaging rules in a module: authoring/packaging-rules.md
          - Writing rule help: authoring/writing-rule-help.md
      - Tutorials:
          - Validate Azure resource configuration: scenarios/azure-resources/azure-resources.md
          - Azure resource tagging example: scenarios/azure-tags/azure-tags.md
          - Kubernetes resource validation example: scenarios/kubernetes-resources/kubernetes-resources.md
          - Using PSRule from a Container: scenarios/containers/container-execution.md
      - Concepts:
          - Baselines: concepts/baselines.md
          - Emitters: concepts/emitters.md
          - Functions: expressions/functions.md
          - Grouping rules: concepts/grouping-rules.md
          - Sub-selectors: expressions/sub-selectors.md
          - Lock file: concepts/lockfile.md
      - Scenarios:
          - Using within continuous integration: scenarios/validation-pipeline/validation-pipeline.md
      - Troubleshooting: troubleshooting.md
      - License and contributing: license-contributing.md
      - Related projects: related-projects.md
      - Support: support.md
    # - Setup:
    #   - Configuring options: setup/configuring-options.md
    #   - Configuring rule defaults: setup/configuring-rules.md
    #   - Configuring expansion: setup/configuring-expansion.md
  - Updates:
      # - January 2025: updates/v3.0.md
      - Change log: 'CHANGELOG-v3.md'
      - Upgrade notes: upgrade-notes.md
      - Deprecations: deprecations.md
      - Changes and versioning: versioning.md
  - Reference:
      - PowerShell cmdlets:
          - Assert-PSRule: commands/PSRule/en-US/Assert-PSRule.md
          - Export-PSRuleBaseline: commands/PSRule/en-US/Export-PSRuleBaseline.md
          - Get-PSRule: commands/PSRule/en-US/Get-PSRule.md
          - Get-PSRuleBaseline: commands/PSRule/en-US/Get-PSRuleBaseline.md
          - Get-PSRuleHelp: commands/PSRule/en-US/Get-PSRuleHelp.md
          - Get-PSRuleTarget: commands/PSRule/en-US/Get-PSRuleTarget.md
          - Invoke-PSRule: commands/PSRule/en-US/Invoke-PSRule.md
          - New-PSRuleOption: commands/PSRule/en-US/New-PSRuleOption.md
          - Set-PSRuleOption: commands/PSRule/en-US/Set-PSRuleOption.md
          - Test-PSRuleTarget: commands/PSRule/en-US/Test-PSRuleTarget.md
      - CLI commands:
          - Index: concepts/cli/index.md
          - run: concepts/cli/run.md
          - module: concepts/cli/module.md
          - restore: concepts/cli/restore.md
      - Assertion methods: concepts/PSRule/en-US/about_PSRule_Assert.md
      - Baselines: concepts/PSRule/en-US/about_PSRule_Baseline.md
      - Badges: concepts/PSRule/en-US/about_PSRule_Badges.md
      - Conventions: concepts/PSRule/en-US/about_PSRule_Conventions.md
      - Documentation: concepts/PSRule/en-US/about_PSRule_Docs.md
      - Expressions: concepts/PSRule/en-US/about_PSRule_Expressions.md
      - Keywords: keywords/PSRule/en-US/about_PSRule_Keywords.md
      - Options: concepts/PSRule/en-US/about_PSRule_Options.md
      - Rules: concepts/PSRule/en-US/about_PSRule_Rules.md
      - Security guidance: concepts/security.md
      - Selectors: concepts/PSRule/en-US/about_PSRule_Selectors.md
      - Suppression Groups: concepts/PSRule/en-US/about_PSRule_SuppressionGroups.md
      - Variables: concepts/PSRule/en-US/about_PSRule_Variables.md
  - FAQ: faq.md
  - Addons:
      - Additional modules: addon-modules.md

markdown_extensions:
  - admonition
  - abbr
  - attr_list
  - def_list
  - footnotes
  - meta
  - md_in_html
  - pymdownx.snippets
  - pymdownx.highlight:
      auto_title: false
      anchor_linenums: false
  - pymdownx.superfences
  - pymdownx.pathconverter
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details
  - mdx_truly_sane_lists
  - pymdownx.tasklist
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - toc:
      permalink: '#'
      separator: '-'

plugins:
  - git-revision-date-localized:
      enable_creation_date: true
      fallback_to_build_date: true
  - git-committers:
      enabled: !ENV [GITHUB_ACTIONS, false]
      repository: microsoft/PSRule
      branch: main
  - search
  - tags:
      tags: false
  - redirects:
      redirect_maps:
        'authoring/writing-rules.md': 'authoring/testing-infrastructure.md'
        'install-instructions.md': 'setup/index.md'
        'install.md': 'setup/index.md'
        'changelog.md': 'CHANGELOG-v3.md'

hooks:
  - docs/hooks/old_hooks.py

# watch:
#   - includes

exclude_docs: |
  specs/

extra:
  version:
    provider: mike
    default: stable

  social:
    - icon: fontawesome/brands/github
      link: https://github.com/microsoft/PSRule/

  local:
    social_preview: https://repository-images.githubusercontent.com/125832556/d6685d9f-ba70-44a1-b11f-6534831143d1
    repo_issue: https://github.com/microsoft/PSRule/issues
    repo_discussion: https://github.com/microsoft/PSRule/discussions

  giscus:
    repo: microsoft/PSRule
    repo_id: MMDEwOlJlcG9zaXRvcnkxMjU4MzI1NTY=
    category: Documentation
    category_id: DIC_kwDOB4ANbM4CRxSO