ogDocumentation/i18n-docu/mkdocs.yml

site_name: OpenGnsys v3.0
site_url: https://opengsys.es
use_directory_urls: true
repo_url: https://dev.opengnsys.es/gitea
repo_name: OpenGnsys Gitea

theme:
  name: material
  language: es
  logo: assets/images/og_balls.png
  favicon: assets/images/og_balls_favicon.png
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.indexes
    - navigation.top
    - navigation.footer
    - navigation.tracking
#    - navigation.instant      # Comentado como lo tenías
    - toc.integrate
    - toc.follow
    - search.suggest
    - search.highlight
    - content.code.copy      # Añadido: botón para copiar bloques de código
    - content.action.edit    # Añadido: si usas GitHub, muestra botón para editar
    - content.code.annotate
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/toggle-switch
        name: Cambiar a modo oscuro
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/toggle-switch-off-outline
        name: Cambiar a modo claro
  icon:
    repo: fontawesome/brands/git
    admonition:
      note: fontawesome/solid/note-sticky
      abstract: fontawesome/solid/book
      info: fontawesome/solid/circle-info
      tip: fontawesome/solid/bullhorn
      success: fontawesome/solid/check
      question: fontawesome/solid/circle-question
      warning: fontawesome/solid/triangle-exclamation
      failure: fontawesome/solid/bomb
      danger: fontawesome/solid/skull
      bug: fontawesome/solid/robot
      example: fontawesome/solid/flask
      quote: fontawesome/solid/quote-left

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html               # Añadido: permite markdown dentro de HTML
  - pymdownx.details
  - pymdownx.superfences:    # Mejorado con configuración
      custom_fences:         # Soporte para diagramas Mermaid
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
      linenums: true         # Añadido: numeración de líneas por defecto
      auto_title: true       # Añadido: muestra el lenguaje como título
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - tables                   # Añadido: mejora el soporte de tablas
  - footnotes                # Añadido: permite añadir notas al pie
  - def_list                 # Añadido: listas de definición
  - pymdownx.critic          # Añadido: marcado de revisiones
  - pymdownx.caret           # Añadido: superíndice
  - pymdownx.keys            # Añadido: teclas de teclado
  - pymdownx.mark            # Añadido: resaltado ==texto==
  - pymdownx.tilde           # Añadido: subíndice y tachado
  - pymdownx.smartsymbols    # Añadido: símbolos como (c), ->, !=, etc.
  - abbr                     # Añadido: abreviaturas
  - pymdownx.snippets:        # Añadido: incluir fragmentos desde archivos
      # Múltiples rutas base para permitir que los snippets funcionen en estructuras multilingües
      # sin tener que cambiar las referencias en los archivos .md
      base_path: [".", "docs", "docs/es/administration", "docs/en/administration"]
      check_paths: true
extra:
  alternate:
    - name: Español
      link: /
      lang: es
    - name: English
      link: /en/
      lang: en

extra_css:
  - assets/css/extra.css

extra_javascript:
  - https://unpkg.com/mermaid/dist/mermaid.in.js

nav:
  - Inicio: index.md
  - Notas de la Versión: index_release.md
  - Instalación: index_installation.md
  - Administración:
    - Visión General: administration/index.md
    - Consola Web: administration/oggui.md
    - DHCP: administration/ogdhcp.md
    - Sistema de Arranque: administration/ogboot.md
    - ogLive: administration/oglive.md
    - Motor de Clonación: administration/ogcloneengine.md
    - Gestión de Repositorios: administration/ogrepository.md
    - ogAgent: administration/ogagent.md
    - Logs y Monitorización: administration/oglog.md
  - Desarrolladores:
    - Visión General: developer/index.md
    - Consola Web: developer/ogcore.md
    - DHCP: developer/ogdhcp.md
    - Sistema de Arranque: developer/ogboot.md
    - ogLive: developer/oglive.md
    - Motor de Clonación: developer/ogcloneengine.md
    - Gestión de Repositorios: developer/ogrepository.md
    - ogAgent: developer/ogagent.md
    - Logs y Monitorización: developer/oglog.md

plugins:
  - enumerate-headings:
      toc_depth: 3
      strict: true
      increment_across_pages: true  # Si quieres numeración continua en múltiples páginas
  - search
#  - awesome-pages
  - include-markdown
  - glightbox:
      touchNavigation: true
      loop: false
      effect: zoom
      slide_effect: slide
      width: 100%
      height: auto
      zoomable: true
      draggable: true
      skip_classes:
        - custom-skip-class-name
      auto_caption: false
      caption_position: bottom
      background: white
      shadow: true
      manual: false
  - i18n:
      reconfigure_material: true
      docs_structure: folder
      languages:
        - locale: es
          name: Español
          build: true
          default: true
        - locale: en
          name: English
          build: true
          nav_translations:
            Inicio: Home
            Notas de la Versión: Release Notes
            Instalación: Installation
            Administración: Administration
            Visión General: Overview
            Consola Web: Web Console
            DHCP: DHCP
            Sistema de Arranque: Boot System
            ogLive: ogLive
            Motor de Clonación: Cloning Engine
            Gestión de Repositorios: Repository Management
            ogAgent: ogAgent
            Logs y Monitorización: Logs and Monitoring
            Desarrolladores: Developers
  - minify:                  # Añadido: minimiza HTML/CSS/JS
      minify_html: true
      minify_js: true
      minify_css: true
  - tags                    # Añadido: soporte para etiquetas
  - social                   # Añadido: imágenes para compartir en redes
  - pdf-generate:
      author: "OpenGnsys"
#      author_logo: img/logo.svg
#      copyright: "Copyright © 2022 - MkDocs PDF Generate"
#      disclaimer: "Disclaimer: Content can change at anytime and best to refer to website for latest information."
#      include_legal_terms: true
      cover: true
      cover_title: TITLE TEXT
      cover_subtitle: SUBTITLE TEXT
      custom_template_path: TEMPLATES PATH
      toc: true
      toc_level: 3
      toc_title: TOC TITLE TEXT
      toc_numbering: true
#      cover_images:
#        default: img/default.svg
#        type1: img/type1.png
#        type2: https://example.com/cover.svg
      enabled_if_env: ENABLE_PDF_EXPORT