mkdocs.yml

site_name: DeclaRenta
# The docs are a directory of the product's Pages artifact, not a site of their
# own: deploy.yml builds them into dist/web/docs after `npm run build:web`, so
# they go live with each release (or a manual run of deploy.yml).
site_url: https://declarenta.com/docs/
site_description: "Herramienta fiscal gratuita para inversores con brokers internacionales: lee los informes de tu broker extranjero y calcula las casillas de la renta con FIFO y tipos de cambio oficiales del BCE."
repo_url: https://github.com/GeiserX/DeclaRenta
repo_name: GeiserX/DeclaRenta
edit_uri: edit/main/docs/

# A warning is a broken link, a missing page or a page nobody can reach. All of
# them fail the build, locally and in CI, so nobody has to remember --strict.
strict: true

theme:
  name: material
  # overrides/partials/source.html keeps the GitHub link in the header but
  # stops Material fetching repo facts from api.github.com in the reader's browser.
  custom_dir: overrides
  language: es
  # No Google Fonts: the product's privacy policy keeps every page on the
  # system font stack, and Material would otherwise load Roboto from Google.
  font: false
  logo: images/logo.svg
  favicon: images/icon.svg
  # Dark first: the first palette entry is the default, and the banners are dark.
  palette:
    - scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Cambiar a modo claro
    - scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Cambiar a modo oscuro
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - content.code.copy
    - content.action.edit
    - search.highlight
    - search.suggest
    - toc.follow
  icon:
    repo: fontawesome/brands/github

# MkDocs reports most link problems as `info`, which --strict ignores. Every
# line here promotes one of them to a warning so the build fails on it:
#   nav.omitted_files   a Markdown file under docs/ that is in no nav entry and
#                       not in exclude_docs (a page nobody can reach, published
#                       at a public URL anyway);
#   nav.not_found       a nav entry whose file does not exist;
#   links.not_found     a relative link to a page or file that does not exist;
#   links.anchors       a link to a heading that does not exist;
#   links.absolute_links  a link written as /path/ (breaks under the /docs/
#                       prefix of the site);
#   links.unrecognized_links  a relative link that leaves docs/ (../README.md).
#                       Repo files are linked by absolute GitHub URL instead.
validation:
  nav:
    omitted_files: warn
    not_found: warn
    absolute_links: warn
  links:
    not_found: warn
    anchors: warn
    absolute_links: warn
    unrecognized_links: warn

plugins:
  - search

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  # base_path includes the repository root, so a page can include a file that
  # ships (docker-compose.yml, .env.example) word for word with
  # `--8<-- "docker-compose.yml"`. A copied example drifts from the real file;
  # an included one cannot. check_paths makes a missing include fail the build
  # instead of rendering an empty block.
  - pymdownx.snippets:
      base_path:
        - .
        - docs
      check_paths: true
  - pymdownx.mark
  - attr_list
  - md_in_html
  # Renders :material-xxx: shortcodes as icons. The grid cards on index.md use
  # them; without this they print as literal text.
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - tables
  - toc:
      permalink: true

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/GeiserX/DeclaRenta
    - icon: fontawesome/brands/docker
      link: https://hub.docker.com/r/drumsergio/declarenta
    - icon: fontawesome/brands/telegram
      link: https://t.me/declarenta

extra_css:
  - stylesheets/theme.css

# Files under docs/ that are not pages. MkDocs publishes every Markdown file in
# docs/ whether or not it is in the nav, so anything that is not a page must be
# listed here. The patterns follow the docs/ contract: a page is a lowercase
# kebab-case .md file; anything with a capital letter (ROADMAP.md, CHANGELOG.md,
# GOAL.md, DESIGN.md) is a repo-facing note, and design/, research/ and notes/
# hold material read on GitHub. Add a line for any other per-repo note.
exclude_docs: |
  [A-Z]*.md
  design/
  research/
  notes/
  requirements-docs.txt
  # The social card source references logo.png in the app tree; it is not a site asset.
  images/social.svg

# One entry per canonical page, in the contract's order. Delete the lines for
# pages the repo does not have. A repo-specific page goes after the canonical
# one it extends (a `Metrics` page after Usage, a `Security` page after
# Configuration). The nav title must equal the page's H1.
nav:
  - Inicio: index.md
  - Primeros pasos:
      - Primeros pasos: getting-started.md
      - Uso: usage.md
      - Brokers soportados: brokers.md
  - Fiscalidad:
      - Modelos fiscales y motor fiscal: modelos-fiscales.md
      - Casillas del Modelo 100: casillas.md
      - Modelo 720, 721 y D-6: modelos-informativos.md
      - Traza del motor de divisas (FX): traza-fx.md
  - Referencia:
      - Preguntas frecuentes: faq.md
      - Solución de problemas: troubleshooting.md
      - Privacidad: privacidad.md
  - Desarrollo: development.md