mkdocs.yml

site_name: Skipper
site_url: https://opensource.zalando.com/skipper/
nav:
    - Introduction: index.md
    - Reference:
        - Filters: reference/filters.md
        - Predicates: reference/predicates.md
        - Backends: reference/backends.md
        - Egress: reference/egress.md
        - Scripts: reference/scripts.md
        - Plugins: reference/plugins.md
        - Architecture: reference/architecture.md
        - Development: reference/development.md
        - Data Clients:
            - Eskip File: data-clients/eskip-file.md
            - Remote Eskip: data-clients/eskip-remote.md
            - Route String: data-clients/route-string.md
            - Kubernetes: data-clients/kubernetes.md
            - Etcd: data-clients/etcd.md
        - Operation:
            - Deployment: operation/deployment.md
            - Operation: operation/operation.md
    - Kubernetes:
        - Ingress Controller Deployment: kubernetes/ingress-controller.md
        - Ingress Usage: kubernetes/ingress-usage.md
        - Ingress Backends: kubernetes/ingress-backends.md
        - RouteGroups: kubernetes/routegroups.md
        - RouteGroup CRD Semantics: kubernetes/routegroup-crd.md
        - RouteGroup Validation: kubernetes/routegroup-validation.md
        - East-West aka svc-to-svc: kubernetes/east-west-usage.md
        - External Addresses aka External Name: kubernetes/external-addresses.md
    - Tutorials:
        - Basics: tutorials/basics.md
        - Common Use Cases: tutorials/common-use-cases.md
        - Authentication and Authorization: tutorials/auth.md
        - Ratelimits: tutorials/ratelimit.md
        - Shadow Traffic: tutorials/shadow-traffic.md
        - Operations: tutorials/operations.md
        - Development: tutorials/development.md
        - Built Your Own Proxy: tutorials/built-your-own.md
theme:
  name: material
  favicon: favicon.ico
  logo: skipper-h180.png
  feature:
    tabs: true
  palette:
    primary: 'white'
  highlightjs: true
  hljs_languages:
  - yaml
  - go
repo_name: GitHub
repo_url: https://github.com/zalando/skipper/
edit_uri: edit/master/docs/
markdown_extensions:
- toc:
    permalink: true
- admonition
- smarty
- extra
- codehilite
- markdown_include.include:
    base_path: docs
- pymdownx.magiclink
- pymdownx.superfences
- pymdownx.details
- pymdownx.mark
- pymdownx.arithmatex:
    generic: true
# https://squidfunk.github.io/mkdocs-material/reference/diagrams/
- pymdownx.superfences:
    custom_fences:
      - name: mermaid
        class: mermaid
        format: !!python/name:pymdownx.superfences.fence_code_format
extra_javascript:
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

plugins:
- search

strict: true