Documentación (MkDocs)¶

Esta documentación está construida con MkDocs Material.

Servicio Docker¶

La documentación corre como un servicio Docker junto con Odoo.

Aspecto	Valor
Imagen	`squidfunk/mkdocs-material`
Puerto interno	8000
Puerto externo	8001 (solo localhost)
Dominio (futuro)	`docs.full3d.cl`

Acceder a la Documentación¶

Opción 1: SSH Tunnel (Desarrollo)¶

Desde tu máquina local:

ssh -L 8001:localhost:8001 root@tu-servidor

Luego abrir en navegador: http://localhost:8001

Opción 2: Traefik (Producción)¶

Cuando el subdominio esté configurado:

Agregar registro DNS: docs.full3d.cl → IP del servidor
Acceder a https://docs.full3d.cl

Comandos¶

Iniciar servicio¶

docker compose up -d docs

Ver estado¶

docker compose ps docs
docker compose logs docs

Reiniciar (después de cambios)¶

docker compose restart docs

Detener¶

docker compose stop docs

Estructura de Archivos¶

/opt/full3d-odoo/
├── mkdocs.yml              # Configuración principal
└── docs/
    ├── index.md            # Página de inicio
    ├── getting-started/    # Sección Comenzar
    ├── developer/          # Guía del Desarrollador
    ├── operations/         # Manual de Operaciones
    ├── business/           # Flujos de Negocio
    └── reference/          # Referencia

Editar Documentación¶

Editar archivos .md en la carpeta docs/
Los cambios se reflejan automáticamente (hot reload)
Si no se reflejan, reiniciar: docker compose restart docs

Agregar Nueva Página¶

Crear archivo .md en la carpeta correspondiente
Agregar entrada en mkdocs.yml sección nav:

nav:
  - Sección:
    - Mi Nueva Página: carpeta/mi-pagina.md

Reiniciar docs si es necesario

Sintaxis Markdown¶

Admonitions (Notas)¶

!!! note "Título opcional"
    Contenido de la nota.

!!! warning "Advertencia"
    Contenido de advertencia.

!!! danger "Peligro"
    Contenido crítico.

Tablas¶

| Columna 1 | Columna 2 |
|-----------|-----------|
| Valor 1   | Valor 2   |

Código¶

```bash
docker compose up -d
```

Diagramas Mermaid¶

```mermaid
flowchart LR
    A[Inicio] --> B[Fin]
```

Checklists¶

- [ ] Tarea pendiente
- [x] Tarea completada

Configuración (mkdocs.yml)¶

Sección	Propósito
`site_name`	Nombre del sitio
`theme`	Tema Material y colores
`plugins`	Plugins habilitados
`markdown_extensions`	Extensiones Markdown
`nav`	Estructura de navegación

Extensiones Habilitadas¶

Extensión	Función
`admonition`	Notas, advertencias, tips
`pymdownx.superfences`	Bloques de código, Mermaid
`pymdownx.tasklist`	Checkboxes
`pymdownx.highlight`	Resaltado de sintaxis
`tables`	Tablas Markdown
`toc`	Tabla de contenidos

Build Estático (Opcional)¶

Para generar HTML estático:

docker run --rm -v $(pwd):/docs squidfunk/mkdocs-material build

Los archivos se generan en site/.