diff --git a/README.md b/README.md index 15eaf95..3f64a36 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,8 @@ MRDevs Tools cuenta con documentación detallada para todas sus funcionalidades: - [Guía de Uso](docs/uso.md): Manual completo de instalación y uso de todas las herramientas - [SOPS](docs/sops.md): Guía para la gestión segura de secretos - [SOPS Rules](docs/sops_rules.md): Configuración de reglas para encriptación -- [Gum Forms](docs/gum.md): Tutorial para interfaces de línea de comandos con Gum +- [Gum](docs/gum.md): Tutorial para interfaces TUI interactivas +- [Glow](docs/glow.md): Guía de uso del renderizador de Markdown ## 🔐 Seguridad y Privacidad diff --git a/docs/glow.md b/docs/glow.md new file mode 100644 index 0000000..5c4b922 --- /dev/null +++ b/docs/glow.md @@ -0,0 +1,187 @@ +# Glow - Renderizador de Markdown para Terminal + +## Introducción + +[Glow](https://github.com/charmbracelet/glow) es un potente renderizador de Markdown para terminal desarrollado por [Charm](https://charm.sh/). Esta herramienta permite visualizar y trabajar con documentos Markdown directamente en la línea de comandos, con soporte para temas, paginación y otras características avanzadas. + +## Instalación + +En MRDevs Tools, Glow se instala automáticamente como parte del proceso de bootstrap: + +```bash +# Instalación de todas las herramientas base (incluye Glow) +bin/bootstrap.sh +``` + +También puedes actualizarlo con: + +```bash +# Actualización del entorno (incluye Glow) +bin/update.sh +``` + +## Características Principales + +- **Renderizado de alta calidad**: Visualiza documentos Markdown con estilos y formato consistentes +- **Soporte para temas**: Incluye temas claro, oscuro y personalizados +- **Modo paginado**: Facilita la lectura de documentos extensos +- **Vista local y remota**: Capacidad para mostrar archivos locales o desde repositorios remotos +- **Navegación mejorada**: Controles intuitivos para navegar entre secciones + +## Uso Básico + +### Visualizar un Archivo Markdown + +Para visualizar un archivo Markdown local: + +```bash +glow README.md +``` + +### Modo Paginado para Archivos Largos + +```bash +glow -p LICENSE.md +``` + +### Seleccionar un Tema + +```bash +# Tema oscuro +glow -s dark README.md + +# Tema claro +glow -s light README.md +``` + +### Ajustar el Ancho del Contenido + +```bash +# Establecer un ancho personalizado (en caracteres) +glow -w 100 README.md +``` + +## Comandos Avanzados + +### Leer un Archivo Markdown Remoto + +```bash +# Desde un repositorio GitHub +glow https://github.com/charmbracelet/glow/blob/master/README.md + +# Desde una URL directa +glow https://raw.githubusercontent.com/charmbracelet/glow/master/README.md +``` + +### Usar Glow en Modo Explorador + +El modo explorador te permite navegar por todos los archivos Markdown en un directorio: + +```bash +glow -l +``` + +### Personalizar Estilos + +```bash +# Ajustar el estilo de los encabezados +glow -s dark --header-fg "#FF5F87" README.md + +# Ajustar el color de fondo +glow -s dark --background "#111111" README.md +``` + +## Integración con MRDevs Tools + +MRDevs Tools aprovecha Glow en diversos componentes: + +1. **Documentación del Proyecto**: Glow es la herramienta recomendada para consultar la documentación del proyecto +2. **Visualización de README**: Facilita la lectura de archivos README de proyectos creados con `project_new.sh` +3. **Información de Ayuda**: Los scripts internos pueden mostrar información de ayuda en formato Markdown + +### Ejemplo de Script que Integra Glow + +```bash +#!/bin/bash +# Ejemplo de integración de Glow en un script + +# Detectar si Glow está disponible +if command -v glow >/dev/null 2>&1; then + RENDER_CMD="glow -" +else + # Fallback si Glow no está disponible + RENDER_CMD="cat" +fi + +# Generar documentación en formato Markdown +cat << EOF | $RENDER_CMD +# Título del Documento + +## Secciones +- Sección 1 +- Sección 2 + +## Código de Ejemplo +\`\`\`bash +echo "Hola Mundo" +\`\`\` +EOF +``` + +## Configuración Personalizada + +Puedes configurar Glow mediante un archivo de configuración: + +```bash +# Crear una configuración inicial +mkdir -p ~/.config/glow +cat > ~/.config/glow/glow.yml << EOF +# Configuración de Glow +style: dark +pager: true +width: 80 +EOF +``` + +## Consejos y Trucos + +1. **Combinar con Gum**: Utiliza Glow junto con [Gum](gum.md) para crear interfaces TUI completas + ```bash + glow README.md | gum pager + ``` + +2. **Vista rápida de archivos**: Establece un alias para previsualizar rápidamente archivos Markdown + ```bash + alias mdview='glow -p' + ``` + +3. **Exportar a HTML**: Puedes convertir Markdown a HTML para otros usos + ```bash + glow -f html README.md > readme.html + ``` + +## Resolución de Problemas + +### Problemas con Colores +Si los colores no se muestran correctamente, asegúrate de que tu terminal soporte 256 colores o true color: +```bash +export TERM=xterm-256color +``` + +### Problemas de Paginación +Si experimentas problemas con el paginador: +```bash +# Usar un paginador alternativo +PAGER=less glow -p README.md +``` + +## Recursos Adicionales + +- [Documentación oficial de Glow](https://github.com/charmbracelet/glow) +- [Charm.sh](https://charm.sh/) - Sitio oficial del desarrollador +- [Markdown Guide](https://www.markdownguide.org/) - Guía completa de Markdown + +--- + +Creado por Cortana Rosero One para MRDevs Tools. +Última actualización: 2025/04/07 \ No newline at end of file diff --git a/docs/uso.md b/docs/uso.md index 106189f..4498d35 100644 --- a/docs/uso.md +++ b/docs/uso.md @@ -154,42 +154,17 @@ MRDevs Tools integra herramientas modernas de Charm para mejorar la experiencia MRDevs Tools incluye soporte completo para herramientas modernas de CLI de [Charm](https://charm.sh/): -#### Gum - Interfaces de Texto Elegantes +#### Gum y Glow - Herramientas TUI Modernas -[Gum](https://github.com/charmbracelet/gum) permite crear interfaces de texto (TUI) elegantes y funcionales: +MRDevs Tools incorpora dos potentes utilidades de [Charm](https://charm.sh/) para mejorar la experiencia de línea de comandos: -```bash -# Abrir el tutorial completo sobre Gum -xdg-open ~/devs/docs/gum.md +- **[Gum](gum.md)**: Crea interfaces TUI interactivas y elegantes para scripts de shell +- **[Glow](glow.md)**: Renderiza archivos Markdown directamente en la terminal con estilos -# Ejemplos rápidos -gum style --border normal --margin "1" --padding "1 2" "Texto con estilo" -gum input --placeholder "Ingresa tu nombre" -gum confirm "¿Deseas continuar?" && echo "Has confirmado" || echo "Has cancelado" -``` +Para obtener información detallada sobre estas herramientas, consulta su documentación específica: -El tutorial incluye: -- Ejemplos prácticos de formularios interactivos -- Guía para crear menús de selección -- Técnicas para estilizar texto y crear layouts complejos -- Referencias visuales de cada componente - -#### Glow - Renderizador de Markdown - -[Glow](https://github.com/charmbracelet/glow) es un renderizador de Markdown para la terminal: - -```bash -# Visualizar un archivo Markdown -glow README.md - -# Visualizar con tema oscuro -glow -s dark README.md - -# Modo paginado para documentos largos -glow -p LICENSE.md -``` - -Para más detalles, consulta la [documentación completa de estas herramientas](gum.md). +- [Documentación completa de Gum](gum.md) +- [Documentación completa de Glow](glow.md) ### Preparación del Entorno