mkdocs_fixed.yml

# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json

# Project info
site_name: LearnNostr
site_description: A comprehensive guide to understanding and building on the Nostr protocol
site_author: LearnNostr Team
site_url: https://learnnostr.com
use_directory_urls: true

# Repository
repo_name: 'LearnNostr'
repo_url: 'https://github.com/cristyalmonte/learnnostr'
edit_uri: 'edit/main/docs/'

# Copyright
copyright: Copyright © 2024 Learn Nostr

# Configuration
theme:
  name: material
  custom_dir: overrides
  language: en
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.highlight
    - search.share
    - content.code.copy
    - announce.dismiss
    - content.code.annotate
    - content.tabs.link
    - content.tooltips
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.path
    - navigation.tabs.sticky
    - navigation.tracking
    - search.suggest
    - toc.follow
  palette:
    - scheme: default
      primary: deep purple
      accent: purple
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: deep purple
      accent: purple
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Inter
    code: Roboto Mono
  favicon: assets/favicon.ico
  logo: assets/logo.svg
  icon:
    repo: fontawesome/brands/github

# Plugins
plugins:
  - search:
      separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
  - i18n:
      docs_structure: folder
      fallback_to_default: true
      reconfigure_material: true
      reconfigure_search: true
      default_language: en
      languages:
        - locale: en
          default: true
          name: English
          build: true
          site_name: "LearnNostr"
          site_description: "A comprehensive guide to understanding and building on the Nostr protocol"
        - locale: es
          name: Español
          build: true
          site_name: "LearnNostr"
          site_description: "Una guía completa para entender y construir sobre el protocolo Nostr"
          nav_translations:
            Home: Inicio
            Getting Started: Comenzar
            Core Concepts: Conceptos Centrales
            Tutorials: Tutoriales
            Support: Soporte
            What is Nostr?: ¿Qué es Nostr?
            Wallet Setup: Configuración de Billetera
            Nostr Tools: Herramientas de Nostr
            Relay Setup: Configuración de Relé
            Clients: Clientes
            Events and Messages: Eventos y Mensajes
            Keys: Llaves
            NIPs: NIPs
            Nostr Fundamentals: Fundamentos de Nostr
            Relays: Relés
            Zaps: Zaps
            Build a Simple Client: Construir un Cliente Simple
            Relay Communication: Comunicación con Relés
            Understanding Events: Entendiendo Eventos
  - git-revision-date-localized:
      type: date
      fallback_to_build_date: true

# Customization
extra:
  announcement: 💜 Join our Discord community to learn Nostr together, ask questions, and connect with other developers! <a href="https://discord.gg/BtkVKRkJ">Join Discord</a>
  social:
    - icon: fontawesome/brands/discord
      link: https://discord.gg/BtkVKRkJ
    - icon: fontawesome/brands/github
      link: https://github.com/cristyalmonte/learnnostr
      name: GitHub
  alternate:
    - name: English
      link: /
      lang: en
    - name: Español
      link: /es/
      lang: es

extra_css:
  - assets/css/custom.css
extra_javascript:
  - assets/js/mathjax.js
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js
  - assets/js/typewriter.js
  - https://unpkg.com/typewriter-effect@latest/dist/core.js
  - https://unpkg.com/mermaid@10.9.0/dist/mermaid.min.js

# Extensions
markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - admonition
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - attr_list
  - md_in_html
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

# Navigation
nav:
  - Home: index.md
  - Modules:
    - Overview: modules/index.md
    - Module 1 - Introduction: modules/module-01-introduction.md
    - Module 2 - Keys & Identity: modules/module-02-keys-identity.md
    - Module 3 - Events & Messages: modules/module-03-events-messages.md
    - Module 4 - Relays & Architecture: modules/module-04-relays-architecture.md
    - Module 5 - Building Your Client: modules/module-05-building-client.md
  - Getting Started:
    - What is Nostr?: getting-started/what-is-nostr.md
    - Wallet Setup: getting-started/wallet-setup.md
    - Nostr Tools: getting-started/nostr-tools.md
    - Relay Setup: getting-started/relay-setup.md
  - Core Concepts:
    - Clients: concepts/clients.md
    - Events and Messages: concepts/events-and-messages.md
    - Keys: concepts/keys.md
    - NIPs: concepts/nips.md
    - Nostr Fundamentals: concepts/nostr-fundamentals.md
    - Relays: concepts/relays.md
    - Zaps: concepts/zaps.md
  - Tutorials:
    - Build a Simple Client: tutorials/simple-client.md
    - Relay Communication: tutorials/relay-communication.md
    - Understanding Events: tutorials/understanding-events.md
  - Support: support.md