Guía Completa: Plantilla de Documentación Moderna
Introducción
Esta plantilla moderna está diseñada para crear documentación profesional y atractiva. Combina un diseño elegante con funcionalidad práctica, perfecta para guías técnicas, documentación de productos, tutoriales y más.
Diseño responsive, modo oscuro, navegación fluida, componentes reutilizables y animaciones suaves que mejoran la experiencia del usuario.
🎨 Diseño Moderno
Interfaz elegante con gradientes, efectos de cristal y sombras suaves que crean una experiencia visual atractiva.
📱 Totalmente Responsive
Se adapta perfectamente a cualquier dispositivo, desde móviles hasta pantallas de escritorio grandes.
⚡ Rápido y Optimizado
Código limpio y optimizado que garantiza tiempos de carga rápidos y una navegación fluida.
Componentes Disponibles
Esta plantilla incluye una amplia variedad de componentes pre-diseñados que puedes usar en tu documentación:
- Headers y Navegación: Cabeceras sticky/estáticas con menú móvil hamburguesa
- Sidebar Inteligente: Navegación lateral con scroll activo y menú móvil deslizante
- Alertas Contextuales: Bloques de información, advertencia, éxito y error
- Bloques de Código: Syntax highlighting con etiquetas de lenguaje
- Listas Avanzadas: Listas numeradas, con iconos y características
- Tablas Responsive: Tablas con scroll horizontal y hover effects
- Sistema de Pestañas: Pestañas interactivas para organizar contenido
- Tarjetas y Grids: Sistema de tarjetas con diseño en cuadrícula
- Botones Interactivos: Múltiples estilos con efectos hover
- Galerías de Imágenes: Contenedores con efectos zoom y captions
Sistema Tipográfico
La plantilla utiliza un sistema tipográfico consistente que garantiza legibilidad y jerarquía visual clara.
Títulos Disponibles
Título Principal (H1) - 2.2rem
Título de Sección (H2) - 1.6rem
Subtítulo (H3) - 1.2rem
Párrafo normal - 1rem con line-height 1.7
Texto pequeño - 0.9remColores de Texto
Texto principal - Blanco suave para máxima legibilidad
Texto secundario - Gris claro para información complementaria
Texto de acento - Azul púrpura para enlaces y elementos destacados
Texto de énfasis - Cian para títulos de sección
Alertas y Bloques Informativos
Utiliza estos bloques para destacar información importante en tu documentación:
Tipos de Alertas
Utiliza este tipo de alerta para proporcionar información adicional, consejos útiles o contexto importante que complementa el contenido principal.
Perfecto para mostrar confirmaciones, pasos completados exitosamente o resultados positivos de una acción.
Usa este bloque para advertencias, información que requiere atención especial o pasos que podrían tener consecuencias si se realizan incorrectamente.
Reservado para errores críticos, información de seguridad importante o acciones que podrían causar problemas graves.
Código HTML para Alertas
Bloques de Código
Presenta código de manera clara y profesional con estos componentes:
Código en Línea
Para elementos pequeños de código dentro del texto, utiliza codigo-inline
que se integra naturalmente en el párrafo.
Bloques de Código
Para fragmentos más largos, utiliza bloques de código con etiquetas de lenguaje:
Tipos de Listas
Organiza información de manera clara con diferentes tipos de listas:
Lista de Pasos Numerados
Perfecto para tutoriales paso a paso o procesos secuenciales:
- Primer Paso: Describe claramente lo que el usuario debe hacer en este paso. Incluye detalles específicos y cualquier información relevante para completar la tarea.
- Segundo Paso: Continúa con el siguiente paso lógico del proceso. Mantén las instrucciones claras y concisas para evitar confusión.
- Tercer Paso: Finaliza el proceso con el paso final. Asegúrate de mencionar el resultado esperado o cómo verificar que se completó correctamente.
Lista de Características
Ideal para enumerar características, beneficios o elementos importantes:
- Característica Principal: Descripción detallada de esta característica y por qué es importante
- Funcionalidad Avanzada: Explica cómo esta función mejora la experiencia del usuario
- Beneficio Clave: Destaca el valor que aporta esta característica al producto final
- Integración Perfecta: Describe cómo se integra con otros componentes del sistema
Tablas de Datos
Presenta información tabular de manera clara y responsive:
Componente | Clase CSS | Uso Recomendado | Compatible |
---|---|---|---|
Alerta de Información | alert alert-info |
Información general y consejos | ✅ Todos los dispositivos |
Bloque de Código | code-block |
Fragmentos de código largos | ✅ Scroll horizontal |
Lista de Pasos | steps-list |
Tutoriales paso a paso | ✅ Mobile friendly |
Tarjeta | card |
Contenido agrupado | ✅ Grid responsive |
Código para Tablas
Contenedores de Imágenes
Muestra imágenes de manera atractiva con efectos y captions:
Código para Imágenes
Sistema de Botones
Botones interactivos con diferentes estilos y efectos:
Sistema de Tarjetas
Organiza contenido en tarjetas atractivas con sistema de grid responsive:
Grid de Tarjetas
🚀 Rendimiento
Optimizado para carga rápida y navegación fluida. Incluye lazy loading y compresión de assets.
🎨 Diseño
Interfaz moderna con efectos glassmorphism, gradientes suaves y animaciones de micro-interacción.
📱 Responsive
Se adapta perfectamente a cualquier tamaño de pantalla desde móviles hasta monitores 4K.
Sistema de Pestañas
Organiza contenido relacionado en pestañas interactivas:
Personalización y Variables CSS
Personaliza fácilmente la apariencia modificando las variables CSS en el root:
Temas Personalizados
Puedes crear diferentes temas cambiando estas variables. Por ejemplo, para un tema más claro: