mkdocs.yml

site_name: Equinor Terraform Baseline

repo_name: equinor/terraform-baseline
repo_url: https://github.com/equinor/terraform-baseline

theme:
  name: material
  icon:
    logo: fontawesome/solid/cube # Set icon to cube to represent the baseline as a "building block"
    repo: fontawesome/brands/github
  features:
  - navigation.instant # Make MkDocs behave like a Single Page Application (SPA).
  - navigation.top # Enables "back-to-top" button.
  - navigation.footer # Enables "previous" and "next" navigation buttons in footer
  - content.action.edit # Enables "Edit this page" button.
  - content.code.copy # Enables "Copy to clipboard" button for code blocks.

  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/weather-night
        name: Switch to light mode

markdown_extensions:
  - toc:
      permalink: true
  - admonition # Enables "call-outs" (notes, info, warnings etc.)
  - pymdownx.highlight # Enable syntax highlighting of code blocks.
  - pymdownx.superfences # Enable arbitrary nesting of code and content blocks inside each other.
  - attr_list # Open links in new tabs by using syntax [<text>](<url>){target=_blank}.

extra_css:
  # Add Equinor fonts
  - https://cdn.eds.equinor.com/font/equinor-font.css
  # Add custom styling
  - stylesheets/extra.css

nav:
  - Overview: index.md
  - Best practices:
    - best-practices/repository.md
    - best-practices/resources.md
    - best-practices/variables-and-outputs.md
    - best-practices/meta-arguments.md
    - best-practices/testing.md
  - Module library: https://registry.terraform.io/search/modules?namespace=equinor