mkdocs.yml

# Project information
site_name: curso_fpga
site_author: Ciro Fabian Bermudez Marquez
site_description: >-
  Documentación de Verilog

# Repository
# repo_name: cirofabianbermudez/curso_fpga
repo_url: https://github.com/cirofabianbermudez/curso_fpga
site_url: https://cirofabianbermudez.com/curso_fpga/

# Copyright
copyright: >- 
  © 2023 Ciro Bermudez
#  &copy; 2023 <a href="https://github.com/cirofabianbermudez"  target="_blank" rel="noopener">Ciro Bermudez</a>

theme:
  name: material
  icon:
    logo: material/library
  features:
    - content.code.copy        # Añade el simbolo de copiar
    - content.code.annotate    # Permite añadir signo (+) en comentarios del código # (1)
    - content.tabs.link        # Cambian los code tabs juntos
    - navigation.footer        # Botones de navegacion en el footer
    - navigation.indexes       # Habilitar index para carpetas
    - navigation.sections      # Despliega las secciones en negritas
    - navigation.tabs          # Cambia la navegacion por pestañas
#    - navigation.tabs.sticky   # Mantener las pestañas siempre
#    - navigation.expand        # Expande las secciones, desactivar tabs
    - navigation.top           # Anade boton para subir rapido
    - navigation.tracking      # Modifica el URL dependiendo de la seccion
    - search.suggest           # Sugerencias del buscador
    - search.highlight         # Resaltar la palabra buscada
#    - search.share            # Boton de compartir en busqueda
    - toc.follow               # Autoscroll table of contents
    - navigation.path          # Muestra la path, para insiders
#    - toc.integrate            # Las secciones las pones a la izquierda, aumenta espacio no compatible con navigation.indexes
# Language configuration
  language: en
# Color palette configuration
  palette:
    - scheme: default
      primary: teal #teal indigo
      accent: teal
      toggle:
        icon: material/brightness-4
        name: Switch to dark mode
    - scheme: slate
      primary: teal
      accent: teal
      toggle:
        icon: material/brightness-7
        name: Switch to light mode
# Font configuration
  font:
    text: Roboto
    code: Roboto Mono

# Plugins para search
plugins:
  - social:
      enabled: true
      cards: true
  - search:
      lang: 
        - en
        - es
      separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
  - glightbox

# Extras
extra:
# Footer configuration
  social:
    - icon: fontawesome/brands/github-alt
      link: https://github.com/cirofabianbermudez
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/CiroBermudez
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/in/ciro-fabian-bermudez-marquez-a93096227/
# Cookie consent
#  consent:
#    title: Cookie consent
#    description: >- 
#      We use cookies to recognize your repeated visits and preferences, as well
#      as to measure the effectiveness of our documentation and whether users
#      find what they're searching for. With your consent, you're helping us to
#      make our documentation better.
# Google analitycs
  analytics:
    provider: google
    property: G-9K60RTS6RK


markdown_extensions:
# Mermaid configuration
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
# Content tabs configuration (pestanias en codigos y anotaciones)
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true 
# Code blocks configuration
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
# Table of contents configuration
  - toc:
      permalink: true
# Admonitions configuration (note, info, tip)
  - admonition
  - pymdownx.details
  - pymdownx.superfences
# Annotations configuration
  - attr_list
  - md_in_html
  - pymdownx.superfences
# Footnotes configuration
  - footnotes
# List configuration
  - def_list
  - pymdownx.tasklist:
      custom_checkbox: true
# Caret, Mark & Tilde configuration
  - pymdownx.caret                # ^^Insert me^^
  - pymdownx.mark                 # ==mark me==
  - pymdownx.tilde                # ~~Delete me~~
# BetterEM condiguration
  - pymdownx.betterem
# Tables configuration
  - tables
# Custom key icons
  - pymdownx.keys
# Smart symbols configuration
  - pymdownx.smartsymbols
# Icons, Emojis configuration
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
# MathJax configuration
  - pymdownx.arithmatex:
      generic: true
  
# MathJaxs javascript configuration
extra_javascript:
  - javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

# Page tree
nav:
  - Home: 
      - index.md
      - Revisiones: revisiones.md
  - Getting started:
      - getting_started/index.md
      - Scripts: getting_started/scripts.md
      - Bibliografía: getting_started/bibliography.md
      - FPGA: getting_started/fpgas.md
      - Verilog Reference: getting_started/verilog_reference.md
      - Code Guidelines: getting_started/code_guidelines.md
      - Acrónimos: getting_started/acronyms.md
      - Extra: getting_started/extra.md
  - Documentación:
      - documentacion/index.md
      - 1. Combinacionales: 
          - documentacion/combinacionales/index.md
          - Look Up Tables: documentacion/combinacionales/look_up_table.md
          - Multiplexores: documentacion/combinacionales/multiplexor.md
          - Codificadores: documentacion/combinacionales/codificador.md
          - Decodificadores: documentacion/combinacionales/decodificador.md
          - ROMs: documentacion/combinacionales/memorias_rom.md
          - Sumadores: documentacion/combinacionales/sumador.md
          - Restadores: documentacion/combinacionales/restador.md
          - Multiplicadores: documentacion/combinacionales/multiplicador.md
      - 2. Secuenciales: 
          - documentacion/secuenciales/index.md
          - Flip-Flop: documentacion/secuenciales/flipflop.md
          - Registros: documentacion/secuenciales/register.md
          - Contadores: documentacion/secuenciales/counter.md
          - FSM Moore: documentacion/secuenciales/fsm_moore.md
          - FSM Mealy: documentacion/secuenciales/fsm_mealy.md
      - 3. Teoría:
          - documentacion/teoria/index.md
          - Punto Fijo: documentacion/teoria/fixed_point.md
          - SCM: documentacion/teoria/scm.md
  - Proyectos: 
      - proyectos/index.md
      - RS232: proyectos/10_rs232/rs232.md