Skip to content

📁 EJEMPLO DE ESTRUCTURA CON SUBCARPETAS

docs/
├── index.md
├── guia/
│   ├── introduccion.md
│   ├── instalacion.md
│   └── uso.md
└── api/
    └── referencia.md

🧭 Cómo poner eso en el menú (mkdocs.yml)

site_name: Mi Web

nav:
  - Inicio: index.md
  - Guía:
      - Introducción: guia/introduccion.md
      - Instalación: guia/instalacion.md
      - Uso: guia/uso.md
  - API:
      - Referencia: api/referencia.md

👉 Fíjate:

  • Usas rutas relativas desde docs/
  • Las carpetas se reflejan en el menú

🧠 Importante (muy típico error)

❌ Esto NO funciona:

- Introducción: introduccion.md

✅ Esto SÍ:

- Introducción: guia/introduccion.md

✨ Ventaja de usar subcarpetas

  • Ordenas mejor el contenido
  • Puedes hacer proyectos grandes
  • El menú queda más limpio

🔥 Truco útil

Puedes llamar en el menú como quieras, aunque el archivo tenga otro nombre:

- Empezar aquí: guia/introduccion.md# MENU LATERAL

El menú lateral en MkDocs se controla desde el archivo mkdocs.yml. Ahí defines la estructura de navegación (lo que luego aparece como menú).

🧭 1. Estructura básica del menú

Edita mkdocs.yml y añade algo así:

site_name: Mi Web

nav:
  - Inicio: index.md
  - Guía: guia.md
  - Acerca de: about.md

👉 Esto crea un menú con 3 enlaces.

📁 2. Crear las páginas

Dentro de docs/ crea los archivos:

```id="9n4kqk" docs/ ├── index.md ├── guia.md └── about.md


Cada archivo es una página.

## 📂 3. Crear secciones (menú con subniveles)

Puedes agrupar páginas:

```yaml
nav:
  - Inicio: index.md
  - Documentación:
      - Introducción: guia.md
      - Instalación: instalacion.md
      - Uso: uso.md
  - Acerca de: about.md

👉 Esto crea un menú tipo:

Inicio
Documentación
  - Introducción
  - Instalación
  - Uso
Acerca de

🗂️ 4. Organizar carpetas

También puedes ordenar archivos en carpetas:

```id="1v6ypl" docs/ ├── index.md ├── guia/ │ ├── introduccion.md │ ├── instalacion.md │ └── uso.md


Y en `mkdocs.yml`:

```yaml
nav:
  - Inicio: index.md
  - Guía:
      - Introducción: guia/introduccion.md
      - Instalación: guia/instalacion.md
      - Uso: guia/uso.md

✨ 5. Menú lateral “bonito” (recomendado)

El menú lateral real (tipo documentación profesional) aparece mejor con el tema:
👉 Material for MkDocs
Instálalo:

pip install mkdocs-material

Y en mkdocs.yml:

theme:
  name: material