mkdocs.yml

edit_uri: !ENV EDIT_URL
markdown_extensions:
  - attr_list
  - admonition
  - footnotes
  - markdown_include.include
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.magiclink
  - pymdownx.superfences
  - pymdownx.tabbed
  - pymdownx.tasklist
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.details
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde
  - toc:
      permalink: ¤
plugins:
  - exclude:
      glob:
        - Blog/blog_template.md
  - blogging:
      template: templates/aucloud_blog.html
      locale: en # babel locale for date localization; without it the runner's LC_TIME=C breaks newer babel (UnknownLocaleError: 'c')
      time_format: "%Y-%m-%d %H:%M:%S" # The format used to display the time
      meta_time_format: "%Y-%m-%d %H:%M:%S"

      features:
        tags: {}
      dirs: # The directories to be included
        - Blog
  - social
  - search
  - macros
  - table-reader:
      data_path: "docs"
  - git-revision-date-localized
  - awesome-pages
  - unused_files:
      strict: True
      file_types:
        - md
        - jpg
        - xlsx
        - png
        - svg
        - pdf
        - csv
        - pptx
        - txt
        - yaml
        - yml
      excluded_files:
        - .pages
        - aucyber.svg
        - "stylesheets/extra.css"
        - "images/favicon.ico"
  - htmlproofer:
      enabled: !ENV [ENABLED_HTMLPROOFER, False]
      validate_rendered_template: False
      validate_external_urls: False
      raise_error_after_finish: False
      raise_error: False
      raise_error_excludes:
        406:
          [
            "https://api-vcd-sz101.portal.australiacloud.com.au/api",
            "https://api-vcd-sz201.portal.australiacloud.com.au/api",
            "https://api-vcd-sz101.eportal.australiacloud.com.au/api",
            "https://api-vcd-sz201.eportal.australiacloud.com.au/api",
          ]
        404:
          - "#__consent"
          - https://vos.s3-sz101.australiacloud.com.au/api/v1/s3
          - https://vos.s3-esz101.australiacloud.com.au/api/v1/s3
        403:
          - https://s3-sz101.australiacloud.com.au
          - https://s3-esz101.australiacloud.com.au
          - https://s3-sz201.australiacloud.com.au
          - https://s3-esz201.australiacloud.com.au

  - spellcheck:
      backends:
        - symspellpy
        - codespell:
            dictionaries: [clear, rare]
      known_words: ../known-words.txt
      # ignore words in <code> tags
      ignore_code: yes
      # minimum length of words to consider
      min_length: 3
      # maximum number of capital letters in a word
      max_capital: 1
      # keep unicode characters
      allow_unicode: no
      # skip_files:
      # - credits.md
      # - coverage.md
      # whether to only check in strict mode
      #strict_only: yes
  - mkdocs-video
  - tags
repo_name: aucloud/aucloud.github.io
repo_url: !ENV REPO_URL
site_description: AUCyber's technical documentation site, managed as code from GitHub
site_name: Technical Documentation
site_url: !ENV SITE_URL
theme:
  logo: aucyber.svg
  favicon: images/favicon.ico
  features:
    - content.code.annotate
    - navigation.tracking
    - navigation.top
    - navigation.indexes
    - navigation.tabs
    - navigation.tabs.sticky
    - header.autohide
    - content.action.edit
    - content.action.view
    - content.code.copy
  name: material
  font:
    text: Questrial
    code: Roboto Mono
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
extra_css:
  - stylesheets/extra.css
extra:
  generator: false
  version:
    provider: mike
  consent:
    title: Cookie consent
    description: >-
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.
  analytics:
    provider: google
    # Internal only
    property: G-ECW6GG6XK3
copyright: >
  Copyright &copy; 2024 Sovereign Cloud Australia Pty Ltd. –
  <a href="#__consent">Change cookie settings</a>