From 8a3c812200bcb17843e42509563964ded816cae1 Mon Sep 17 00:00:00 2001 From: zivito Date: Thu, 31 Oct 2024 15:44:16 -0300 Subject: [PATCH] Update Documentation Structure --- docs/{en => }/api/core-classes.md | 0 .../core-classes.pt.md} | 0 docs/{en => }/api/helper-functions.md | 0 .../helper-functions.pt.md} | 0 docs/{en => }/api/overview.md | 0 .../api/overview.md => api/overview.pt.md} | 0 docs/{en => }/api/scene-interface.md | 0 .../scene-interface.pt.md} | 0 docs/{en => }/author.md | 0 docs/{pt/author.md => author.pt.md} | 0 docs/{en => }/contributing.md | 0 .../contributing.md => contributing.pt.md} | 0 docs/{en => }/examples/advanced.md | 0 .../advanced.md => examples/advanced.pt.md} | 0 docs/{en => }/examples/basic.md | 0 .../basic.md => examples/basic.pt.md} | 0 docs/{en => }/getting-started/features.md | 0 .../features.pt.md} | 0 docs/{en => }/getting-started/quickstart.md | 0 .../quickstart.pt.md} | 0 docs/{en => }/index.md | 0 docs/{pt/index.md => index.pt.md} | 0 docs/{en => }/installation/dependencies.md | 0 .../dependencies.pt.md} | 0 .../installation/installation-steps.md | 0 .../installation-steps.pt.md} | 0 docs/{en => }/installation/requirements.md | 0 .../requirements.pt.md} | 0 docs/{en => }/known-issues.md | 0 .../known-issues.md => known-issues.pt.md} | 0 docs/{en => }/license.md | 0 docs/{pt/license.md => license.pt.md} | 0 docs/{en => }/usage/basic-usage.md | 0 .../basic-usage.pt.md} | 0 docs/{en => }/usage/event-handling.md | 0 .../event-handling.pt.md} | 0 docs/{en => }/usage/external-integration.md | 0 .../external-integration.pt.md} | 0 docs/{en => }/usage/scene-management.md | 0 .../scene-management.pt.md} | 0 mkdocs.yml | 150 +++++++++--------- 41 files changed, 78 insertions(+), 72 deletions(-) rename docs/{en => }/api/core-classes.md (100%) rename docs/{pt/api/core-classes.md => api/core-classes.pt.md} (100%) rename docs/{en => }/api/helper-functions.md (100%) rename docs/{pt/api/helper-functions.md => api/helper-functions.pt.md} (100%) rename docs/{en => }/api/overview.md (100%) rename docs/{pt/api/overview.md => api/overview.pt.md} (100%) rename docs/{en => }/api/scene-interface.md (100%) rename docs/{pt/api/scene-interface.md => api/scene-interface.pt.md} (100%) rename docs/{en => }/author.md (100%) rename docs/{pt/author.md => author.pt.md} (100%) rename docs/{en => }/contributing.md (100%) rename docs/{pt/contributing.md => contributing.pt.md} (100%) rename docs/{en => }/examples/advanced.md (100%) rename docs/{pt/examples/advanced.md => examples/advanced.pt.md} (100%) rename docs/{en => }/examples/basic.md (100%) rename docs/{pt/examples/basic.md => examples/basic.pt.md} (100%) rename docs/{en => }/getting-started/features.md (100%) rename docs/{pt/getting-started/features.md => getting-started/features.pt.md} (100%) rename docs/{en => }/getting-started/quickstart.md (100%) rename docs/{pt/getting-started/quickstart.md => getting-started/quickstart.pt.md} (100%) rename docs/{en => }/index.md (100%) rename docs/{pt/index.md => index.pt.md} (100%) rename docs/{en => }/installation/dependencies.md (100%) rename docs/{pt/installation/dependencies.md => installation/dependencies.pt.md} (100%) rename docs/{en => }/installation/installation-steps.md (100%) rename docs/{pt/installation/installation-steps.md => installation/installation-steps.pt.md} (100%) rename docs/{en => }/installation/requirements.md (100%) rename docs/{pt/installation/requirements.md => installation/requirements.pt.md} (100%) rename docs/{en => }/known-issues.md (100%) rename docs/{pt/known-issues.md => known-issues.pt.md} (100%) rename docs/{en => }/license.md (100%) rename docs/{pt/license.md => license.pt.md} (100%) rename docs/{en => }/usage/basic-usage.md (100%) rename docs/{pt/usage/basic-usage.md => usage/basic-usage.pt.md} (100%) rename docs/{en => }/usage/event-handling.md (100%) rename docs/{pt/usage/event-handling.md => usage/event-handling.pt.md} (100%) rename docs/{en => }/usage/external-integration.md (100%) rename docs/{pt/usage/external-integration.md => usage/external-integration.pt.md} (100%) rename docs/{en => }/usage/scene-management.md (100%) rename docs/{pt/usage/scene-management.md => usage/scene-management.pt.md} (100%) diff --git a/docs/en/api/core-classes.md b/docs/api/core-classes.md similarity index 100% rename from docs/en/api/core-classes.md rename to docs/api/core-classes.md diff --git a/docs/pt/api/core-classes.md b/docs/api/core-classes.pt.md similarity index 100% rename from docs/pt/api/core-classes.md rename to docs/api/core-classes.pt.md diff --git a/docs/en/api/helper-functions.md b/docs/api/helper-functions.md similarity index 100% rename from docs/en/api/helper-functions.md rename to docs/api/helper-functions.md diff --git a/docs/pt/api/helper-functions.md b/docs/api/helper-functions.pt.md similarity index 100% rename from docs/pt/api/helper-functions.md rename to docs/api/helper-functions.pt.md diff --git a/docs/en/api/overview.md b/docs/api/overview.md similarity index 100% rename from docs/en/api/overview.md rename to docs/api/overview.md diff --git a/docs/pt/api/overview.md b/docs/api/overview.pt.md similarity index 100% rename from docs/pt/api/overview.md rename to docs/api/overview.pt.md diff --git a/docs/en/api/scene-interface.md b/docs/api/scene-interface.md similarity index 100% rename from docs/en/api/scene-interface.md rename to docs/api/scene-interface.md diff --git a/docs/pt/api/scene-interface.md b/docs/api/scene-interface.pt.md similarity index 100% rename from docs/pt/api/scene-interface.md rename to docs/api/scene-interface.pt.md diff --git a/docs/en/author.md b/docs/author.md similarity index 100% rename from docs/en/author.md rename to docs/author.md diff --git a/docs/pt/author.md b/docs/author.pt.md similarity index 100% rename from docs/pt/author.md rename to docs/author.pt.md diff --git a/docs/en/contributing.md b/docs/contributing.md similarity index 100% rename from docs/en/contributing.md rename to docs/contributing.md diff --git a/docs/pt/contributing.md b/docs/contributing.pt.md similarity index 100% rename from docs/pt/contributing.md rename to docs/contributing.pt.md diff --git a/docs/en/examples/advanced.md b/docs/examples/advanced.md similarity index 100% rename from docs/en/examples/advanced.md rename to docs/examples/advanced.md diff --git a/docs/pt/examples/advanced.md b/docs/examples/advanced.pt.md similarity index 100% rename from docs/pt/examples/advanced.md rename to docs/examples/advanced.pt.md diff --git a/docs/en/examples/basic.md b/docs/examples/basic.md similarity index 100% rename from docs/en/examples/basic.md rename to docs/examples/basic.md diff --git a/docs/pt/examples/basic.md b/docs/examples/basic.pt.md similarity index 100% rename from docs/pt/examples/basic.md rename to docs/examples/basic.pt.md diff --git a/docs/en/getting-started/features.md b/docs/getting-started/features.md similarity index 100% rename from docs/en/getting-started/features.md rename to docs/getting-started/features.md diff --git a/docs/pt/getting-started/features.md b/docs/getting-started/features.pt.md similarity index 100% rename from docs/pt/getting-started/features.md rename to docs/getting-started/features.pt.md diff --git a/docs/en/getting-started/quickstart.md b/docs/getting-started/quickstart.md similarity index 100% rename from docs/en/getting-started/quickstart.md rename to docs/getting-started/quickstart.md diff --git a/docs/pt/getting-started/quickstart.md b/docs/getting-started/quickstart.pt.md similarity index 100% rename from docs/pt/getting-started/quickstart.md rename to docs/getting-started/quickstart.pt.md diff --git a/docs/en/index.md b/docs/index.md similarity index 100% rename from docs/en/index.md rename to docs/index.md diff --git a/docs/pt/index.md b/docs/index.pt.md similarity index 100% rename from docs/pt/index.md rename to docs/index.pt.md diff --git a/docs/en/installation/dependencies.md b/docs/installation/dependencies.md similarity index 100% rename from docs/en/installation/dependencies.md rename to docs/installation/dependencies.md diff --git a/docs/pt/installation/dependencies.md b/docs/installation/dependencies.pt.md similarity index 100% rename from docs/pt/installation/dependencies.md rename to docs/installation/dependencies.pt.md diff --git a/docs/en/installation/installation-steps.md b/docs/installation/installation-steps.md similarity index 100% rename from docs/en/installation/installation-steps.md rename to docs/installation/installation-steps.md diff --git a/docs/pt/installation/installation-steps.md b/docs/installation/installation-steps.pt.md similarity index 100% rename from docs/pt/installation/installation-steps.md rename to docs/installation/installation-steps.pt.md diff --git a/docs/en/installation/requirements.md b/docs/installation/requirements.md similarity index 100% rename from docs/en/installation/requirements.md rename to docs/installation/requirements.md diff --git a/docs/pt/installation/requirements.md b/docs/installation/requirements.pt.md similarity index 100% rename from docs/pt/installation/requirements.md rename to docs/installation/requirements.pt.md diff --git a/docs/en/known-issues.md b/docs/known-issues.md similarity index 100% rename from docs/en/known-issues.md rename to docs/known-issues.md diff --git a/docs/pt/known-issues.md b/docs/known-issues.pt.md similarity index 100% rename from docs/pt/known-issues.md rename to docs/known-issues.pt.md diff --git a/docs/en/license.md b/docs/license.md similarity index 100% rename from docs/en/license.md rename to docs/license.md diff --git a/docs/pt/license.md b/docs/license.pt.md similarity index 100% rename from docs/pt/license.md rename to docs/license.pt.md diff --git a/docs/en/usage/basic-usage.md b/docs/usage/basic-usage.md similarity index 100% rename from docs/en/usage/basic-usage.md rename to docs/usage/basic-usage.md diff --git a/docs/pt/usage/basic-usage.md b/docs/usage/basic-usage.pt.md similarity index 100% rename from docs/pt/usage/basic-usage.md rename to docs/usage/basic-usage.pt.md diff --git a/docs/en/usage/event-handling.md b/docs/usage/event-handling.md similarity index 100% rename from docs/en/usage/event-handling.md rename to docs/usage/event-handling.md diff --git a/docs/pt/usage/event-handling.md b/docs/usage/event-handling.pt.md similarity index 100% rename from docs/pt/usage/event-handling.md rename to docs/usage/event-handling.pt.md diff --git a/docs/en/usage/external-integration.md b/docs/usage/external-integration.md similarity index 100% rename from docs/en/usage/external-integration.md rename to docs/usage/external-integration.md diff --git a/docs/pt/usage/external-integration.md b/docs/usage/external-integration.pt.md similarity index 100% rename from docs/pt/usage/external-integration.md rename to docs/usage/external-integration.pt.md diff --git a/docs/en/usage/scene-management.md b/docs/usage/scene-management.md similarity index 100% rename from docs/en/usage/scene-management.md rename to docs/usage/scene-management.md diff --git a/docs/pt/usage/scene-management.md b/docs/usage/scene-management.pt.md similarity index 100% rename from docs/pt/usage/scene-management.md rename to docs/usage/scene-management.pt.md diff --git a/mkdocs.yml b/mkdocs.yml index 06dc305..ce9b246 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,20 +1,31 @@ -site_name: ziviDomeLive -site_url: "https://vicvalentim.github.io/ziviDomeLive/" -use_directory_urls: false # Para documentação offline +site_name: ziviDomeLive - Processing Library Documentation +site_url: https://vicvalentim.github.io/ziviDomeLive/ +repo_url: https://github.com/vicvalentim/ziviDomeLive +repo_name: "GitHub" +edit_uri: "blob/main/docs/" +site_description: "Real-time immersive visuals and 3D rendering framework for fulldome and VR in Processing" +site_author: "Victor Valentim" +copyright: Copyright © 2024 Victor Valentim - MIT License theme: name: material language: en palette: - - scheme: slate - toggle: - icon: material/brightness-4 - name: Switch to light mode - - scheme: default + # Palette toggle for light mode + - media: "(prefers-color-scheme: light)" + primary: blue + scheme: default toggle: - icon: material/brightness-7 + icon: material/weather-sunny name: Switch to dark mode + # Palette toggle for dark mode + - media: "(prefers-color-scheme: dark)" + primary: blue grey + scheme: slate + toggle: + icon: material/weather-night + name: Switch to light mode features: - search.suggest @@ -32,16 +43,45 @@ plugins: - search - offline - i18n: - docs_structure: folder + reconfigure_material: true + reconfigure_search: true + docs_structure: suffix languages: - locale: en default: true name: English build: true - locale: pt - default: false name: Português (Brasil) build: true + site_name: ziviDomeLive - Documentação da Biblioteca Processing + site_description: "Framework de visualização imersiva em tempo real e renderização 3D para fulldome e VR em Processing" + nav_translations: + Home: "Início" + Installation: "Instalação" + Requirements: "Requisitos" + Installation Steps: "Passos de Instalação" + Dependencies: "Dependências" + Getting Started: "Introdução" + Quickstart Guide: "Guia Rápido" + Key Features: "Funcionalidades Principais" + Usage: "Uso" + Basic Usage: "Uso Básico" + Scene Management: "Gerenciamento de Cenas" + Event Handling: "Manipulação de Eventos" + External Integration: "Integração Externa" + API Reference: "Referência da API" + Overview: "Visão Geral" + Core Classes: "Classes Principais" + Scene Interface: "Interface de Cena" + Helper Functions: "Funções Auxiliares" + Examples: "Exemplos" + Basic Examples: "Exemplos Básicos" + Advanced Examples: "Exemplos Avançados" + Contributing: "Contribuindo" + Known Issues: "Problemas Conhecidos" + Author: "Autor" + License: "Licença" markdown_extensions: - admonition @@ -65,20 +105,13 @@ markdown_extensions: line_spans: __span pygments_lang_class: true -repo_url: https://github.com/vicvalentim/ziviDomeLive -repo_name: "GitHub" -edit_uri: "blob/main/docs/" -site_description: "Real-time immersive visuals and 3D rendering framework for fulldome and VR in Processing" -site_author: "Victor Valentim" -copyright: Copyright © 2024 Victor Valentim - MIT License - extra: alternate: - name: English - link: /ziviDomeLive/en/ + link: /en/ lang: en - name: Português (Brasil) - link: /ziviDomeLive/pt/ + link: /pt/ lang: pt extra_css: @@ -86,55 +119,28 @@ extra_css: # Navegação da documentação nav: - - en: - - Home: en/index.md - - Installation: - - Requirements: en/installation/requirements.md - - Installation Steps: en/installation/installation-steps.md - - Dependencies: en/installation/dependencies.md - - Getting Started: - - Quickstart Guide: en/getting-started/quickstart.md - - Key Features: en/getting-started/features.md - - Usage: - - Basic Usage: en/usage/basic-usage.md - - Scene Management: en/usage/scene-management.md - - Event Handling: en/usage/event-handling.md - - External Integration: en/usage/external-integration.md - - API Reference: - - Overview: en/api/overview.md - - Core Classes: en/api/core-classes.md - - Scene Interface: en/api/scene-interface.md - - Helper Functions: en/api/helper-functions.md - - Examples: - - Basic Examples: en/examples/basic.md - - Advanced Examples: en/examples/advanced.md - - Contributing: en/contributing.md - - Known Issues: en/known-issues.md - - Author: en/author.md - - License: en/license.md - - pt: - - Home: pt/index.md - - Instalação: - - Requisitos: pt/installation/requirements.md - - Passos de Instalação: pt/installation/installation-steps.md - - Dependências: pt/installation/dependencies.md - - Introdução: - - Guia Rápido: pt/getting-started/quickstart.md - - Funcionalidades Principais: pt/getting-started/features.md - - Uso: - - Uso Básico: pt/usage/basic-usage.md - - Gerenciamento de Cenas: pt/usage/scene-management.md - - Manipulação de Eventos: pt/usage/event-handling.md - - Integração Externa: pt/usage/external-integration.md - - Referência da API: - - Visão Geral: pt/api/overview.md - - Classes Principais: pt/api/core-classes.md - - Interface de Cena: pt/api/scene-interface.md - - Funções Auxiliares: pt/api/helper-functions.md - - Exemplos: - - Exemplos Básicos: pt/examples/basic.md - - Exemplos Avançados: pt/examples/advanced.md - - Contribuindo: pt/contributing.md - - Problemas Conhecidos: pt/known-issues.md - - Autor: pt/author.md - - Licença: pt/license.md + - Home: index.md + - Installation: + - Requirements: installation/requirements.md + - Installation Steps: installation/installation-steps.md + - Dependencies: installation/dependencies.md + - Getting Started: + - Quickstart Guide: getting-started/quickstart.md + - Key Features: getting-started/features.md + - Usage: + - Basic Usage: usage/basic-usage.md + - Scene Management: usage/scene-management.md + - Event Handling: usage/event-handling.md + - External Integration: usage/external-integration.md + - API Reference: + - Overview: api/overview.md + - Core Classes: api/core-classes.md + - Scene Interface: api/scene-interface.md + - Helper Functions: api/helper-functions.md + - Examples: + - Basic Examples: examples/basic.md + - Advanced Examples: examples/advanced.md + - Contributing: contributing.md + - Known Issues: known-issues.md + - Author: author.md + - License: license.md