mkdocs-base.yml

site_name: Wallarm Documentation
site_url: https://docs.wallarm.com/
site_description: The Wallarm solution protects APIs, microservices and web applications from OWASP API Top 10 threats, API abuse and other automated threats with no manual rule configuration and ultra‑low false positives.

repo_url: https://github.com/wallarm/product-documentation
repo_name: GitHub

copyright: '<a href="https://www.wallarm.com/terms-of-service" target="_blank">Terms of services</a> | <a href="https://www.wallarm.com/privacy-policy" target="_blank">Privacy policy</a> | <a href="https://www.wallarm.com/cookie-policy" target="_blank">Cookie policy</a> | <a href="#__consent">Cookie settings</a> | 2024 © Wallarm Inc.'

plugins:
  - search
  - minify:
      minify_html: true
      minify_js: true
      minify_css: true
      js_files:
          - extra.js
          - feedback.js
          - supported-platforms.js
      css_files:
          - extra_new.css
          - supported-platforms.css
  - meta-descriptions
  - meta
  - glightbox:
      skip_classes:
        - non-zoomable
  - group:
      enabled: !ENV INSIDERS
      plugins:
        - optimize
dev_addr: '127.0.0.1:8000'

watch:
  - docs/latest
  - stylesheets

theme:
  language_name: English
  language: en
  language_lowercase: en
  name: material
  custom_dir: stylesheets
  palette:
    scheme: wallarm-palette
  features:
    - navigation.top
    - navigation.prune
    - content.code.copy
    - content.code.select
    - content.action.edit
    - search.suggest
    - content.tabs.link
  logo: images/wallarm-logo-new.svg
  favicon: images/favicon.svg
  icon:
    repo: fontawesome/brands/github-alt
  font:
    text: Sk Modernist
    code: Roboto Mono
  playground_button_name: "Explore Playground"
  footer:
    need_help: Need help or have questions?
    contact_support: Contact Support
    contact_sales: Contact Sales

extra:
  social:
    - icon: fontawesome/solid/globe
      link: https://www.wallarm.com
    - icon: fontawesome/brands/github-alt
      link: https://github.com/wallarm
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/wallarm
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/wallarm
    - icon: fontawesome/brands/youtube
      link: https://www.youtube.com/channel/UCgD4zSzAJwf3tBlOgJo7Qkw
  generator: false
  consent:
    cookies:
      analytics:
        name: Google Analytics
        checked: true
    title: Cookie consent
    description: We use cookies to optimize our documentation and collect valuable feedback. Your consent helps us improve! Learn more in our <a href="https://www.wallarm.com/cookie-policy" target="_blank">Cookie policy</a>.
    actions:
      - accept
      - reject
      - manage
  analytics:
    provider: google
    property: G-3Z9P1Z18D8
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: /images/happy-feedback.png
          name: This page was helpful
          data: 1
          note: >-
            Thanks for your feedback!
        - icon: /images/disappointed-feedback.png
          name: This page could be improved
          data: 0
          note: >- 
            Thanks for your feedback!
      negative:
        ask_reason: How can we improve this article? (Optional)
        unclear: Information is unclear or confusing
        missing: Insufficient information
        outdated: Outdated or incorrect information
        input_placeholder: Share your experience in more detail
        send_button: Send

extra_css:
  - 'extra_new.css'

extra_javascript:
  - 'extra.js'
  - 'feedback.js'

markdown_extensions:
  - admonition
  - pymdownx.highlight:
      linenums_style: table
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - toc:
      permalink: true
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.tasklist
  - pymdownx.snippets:
      check_paths: true
      base_path: docs
      restrict_base_path: false
  - nl2br
  - tables
  - sane_lists
  - attr_list
  - prependnewline
  - meta
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      options:
        custom_icons:
          - stylesheets/.icons

edit_uri: ../product-documentation/edit/master/docs/latest/

validation:
  absolute_links: ignore
  unrecognized_links: ignore