mkdocs.yml

site_name: BIG-IP Kubernetes GatewayAPI Controller
extra_css:
  - stylesheets/extra.css

theme:
  name: material
  custom_dir: overrides
  highlightjs: true
  language: en
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.top
    - toc.follow
    - navigation.tracking
    - content.code.annotate
    - content.tooltips
    - search.highlight
    - search.share
    - search.suggest
    - announce.dismiss


# Extensions
markdown_extensions:
  - abbr
  - admonition
  - fenced_code
  - attr_list
  - def_list
  - footnotes
  - meta
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:materialx.emoji.to_svg
      emoji_index: !!python/name:materialx.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

nav:
  - Overview: index.md
  - Releases: Release-notes/index.md
  # - Getting Started:
  #   - Prerequisites: deploy/index.md
  #   - Installation Guide: deploy/installation.md
  #   - Unstallation Guide: deploy/uninstall.md
  #   - Controller Parameters: deploy/parameters.md
  - Concepts:
    - Overview: concepts/index.md
    - GatewayClass: concepts/gatewayclass.md
    - Gateway: concepts/gateway.md 
    - HTTPRoute: concepts/httproute.md
    - RBAC: concepts/rbac.md
    - Rolespersonas: concepts/rolespersonas.md
  - Design:
    - BIG-IP Controller Overview: Design/bip.md
    - BIG-IP Next Controller Overview: Design/bipnext.md
    # - BIG-IP Providers: Design/gatewayclassrefer.md
    # - Resource Layout: Design/resources-layout.md
  - Guides(For BIG-IP):
    - Getting started: guides/getstarted.md
    - Simple Gateway: guides/simple-gateway.md
    - HTTP Routing: guides/http-routing.md
    - HTTP Redirects and Rewrites: guides/http-redirect-rewrite.md
    - HTTP Traffic Splitting: guides/traffic-splitting.md
    - Cross-Namespace Routing: guides/multiple-ns.md
    - TLS: guides/tls.md
    - TCP Routing: guides/tcp.md
    - gRPC Routing: guides/grpc-routing.md
    - Common FAQ: Operation-and-troubleshooting/ki.md
    - Troubleshooting: Operation-and-troubleshooting/trubeshooting.md
  
  - Guides(For BIG-IP Next):
    - Getting started: guides-next/getstarted.md

  # - Operations:
  - Contact Us: 
    - Tech Support: Support-and-contact/index.md
    - Contributions: Support-and-contact/contributions.md

plugins:
  - search:
      separator: '[\s\u200b\-]'
  - git-revision-date-localized:
      type: datetime
      timezone: Asia/Shanghai
      enable_creation_date: true
      locale: en
      fallback_to_build_date: true
  - minify:
      minify_html: true
      htmlmin_opts:
        remove_comments: true

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/f5se/bigip-gatewayapi-docs/
    - icon: fontawesome/brands/docker
      link: https://hub.docker.com/r/f5devcentral/bigip-gatewayapi/tags


# Repository
repo_name: f5se/bigip-gatewayapi-docs
repo_url: https://github.com/f5se/bigip-gatewayapi-docs

# Copyright
copyright: Copyright © 2022 F5