mkdocs.yml

Rama main · réplica de lectura del repositorio original.

site_name: Argus
site_description: Observability for Docker hosts and workloads
site_url: https://harryraddatz.github.io/argus-observability/
repo_url: https://github.com/HarryRaddatz/argus-observability
repo_name: HarryRaddatz/argus-observability
edit_uri: edit/main/docs/
docs_dir: docs
site_dir: site
copyright: MIT

theme:
  name: material
  language: en
  logo: assets/logo.svg
  favicon: assets/logo.svg
  font:
    text: Inter
    code: JetBrains Mono
  features:
    - navigation.sections
    - navigation.top
    - navigation.footer
    - navigation.tracking
    - toc.follow
    - content.code.copy
    - search.suggest
    - search.highlight
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Light mode

extra_css:
  - stylesheets/extra.css

extra:
  generator: false
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/HarryRaddatz/argus-observability

hooks:
  - .github/pages/hooks.py

plugins:
  - search
  - i18n:
      docs_structure: suffix
      fallback_to_default: true
      reconfigure_material: true
      languages:
        - locale: en
          default: true
          name: English
          build: true
        - locale: pt
          name: Português
          build: true
          nav_translations:
            Home: Início
            Get started: Começar
            Overview: Visão geral
            Deploy: Deploy
            Panel: Painel
            API: API
            Reference: Referência
            Configuration: Configuração
            Ingest: Ingest
            Query: Query
            Observability: Observability
            Flows: Fluxos
            Agent connection: Conexão do agent
            Metrics ingest: Ingestão de métricas
            Log streaming: Streaming de logs
            Events and alerts: Eventos e alertas
            Project: Projeto
            Product map: Mapa do produto
            Roadmap: Roadmap
            Changelog: Novidades
            Contributing: Contribuir

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

validation:
  links:
    not_found: warn
    anchors: warn
    unrecognized_links: warn

nav:
  - Home: index.md
  - Get started:
      - Overview: overview.md
      - Deploy: deploy.md
      - Panel: flows/ui-panel.md
  - API:
      - Reference: api/README.md
      - Configuration: api/configuration.md
      - Ingest: api/ingest.md
      - Query: api/query.md
      - Observability: api/observability.md
  - Flows:
      - Agent connection: flows/agent-connection.md
      - Metrics ingest: flows/metrics-ingestion.md
      - Log streaming: flows/log-streaming.md
      - Events and alerts: flows/events-and-alerts.md
  - Project:
      - Product map: map.md
      - Roadmap: public-library/roadmap.md
      - Changelog: changelog.md
      - Contributing: contributing.md