Datos clave
- Categoría
- Document Tools
- Tipos de entrada
- textarea, text, select, checkbox
- Tipo de salida
- file
- Cobertura de muestras
- 4
- API disponible
- Yes
Resumen
El Visor de Fragmentos de Código PDF permite transformar bloques de código fuente en documentos PDF profesionales, aplicando formato de fuente monoespaciada, fondos legibles y enlaces directos a tu repositorio de Git para facilitar las revisiones de código.
Cuándo usarlo
- •Preparar fragmentos de código para revisiones técnicas fuera del entorno de desarrollo.
- •Documentar lógica específica de un repositorio en un formato portátil y profesional.
- •Compartir ejemplos de código con enlaces directos a la fuente original en GitHub o GitLab.
Cómo funciona
- •Ingresa los fragmentos de código en formato JSON, incluyendo la ruta del archivo y las líneas correspondientes.
- •Configura la URL base del repositorio y la rama para habilitar los enlaces clicables en el PDF.
- •Selecciona el tamaño de página, la orientación y el tema visual (claro u oscuro) según tus preferencias.
- •Genera y descarga el archivo PDF listo para compartir o imprimir.
Casos de uso
Ejemplos
1. Revisión de código en tema claro
Desarrollador Senior- Contexto
- Necesito presentar dos módulos de un proyecto TypeScript en una reunión de revisión de código.
- Problema
- El código debe ser legible y permitir a los revisores saltar directamente al repositorio para ver el contexto completo.
- Cómo usarlo
- Pego los fragmentos en el campo JSON, configuro la URL del repositorio y selecciono el tema claro.
- Configuración de ejemplo
-
{"theme": "light", "pageSize": "A4", "repoBaseUrl": "https://github.com/example/repo"} - Resultado
- Un PDF limpio con formato monoespaciado y enlaces funcionales a los archivos en GitHub.
2. Documentación técnica en modo oscuro
Arquitecto de Software- Contexto
- Estoy documentando una clase compleja de gestión de herramientas para un manual interno.
- Problema
- El código es extenso y requiere una visualización horizontal para evitar saltos de línea innecesarios.
- Cómo usarlo
- Configuro el modo horizontal y el tema oscuro para resaltar la sintaxis.
- Configuración de ejemplo
-
{"theme": "dark", "landscape": true, "pageSize": "Letter"} - Resultado
- Un PDF con diseño horizontal que muestra el código con alto contraste y estilo profesional.
Probar con muestras
json, pdfHubs relacionados
Preguntas frecuentes
¿Qué formatos de página admite la herramienta?
Actualmente puedes generar documentos en formato A4 o Letter.
¿Puedo cambiar el aspecto visual del código?
Sí, puedes elegir entre un tema claro u oscuro para adaptar la legibilidad del código.
¿Los enlaces en el PDF funcionan realmente?
Sí, al configurar la URL base del repositorio, el PDF incluirá enlaces clicables que dirigen a la ubicación exacta del archivo en tu plataforma Git.
¿Es necesario incluir el número de línea?
Sí, el JSON de entrada requiere especificar las líneas de inicio y fin para referenciar correctamente el código en el repositorio.
¿Puedo generar un PDF en orientación horizontal?
Sí, puedes activar la opción 'Horizontal' para ajustar el diseño a tus necesidades de visualización.