Repolode
Enviar
thiagokokada

thiagokokada/gh-gfm-preview

Una CLI de Go y extensión de GitHub CLI que inicia un servidor web local para previsualizar GitHub Flavored Markdown, incluso sin conexión.

Alternativa open source a:GitHub Markdown preview

Ver en GitHub
Estrellas
133
Forks
4
Issues abiertos
0
Último commit
hace 3 meses

¿Qué es?

gh-gfm-preview inicia un servidor web local que muestra un archivo Markdown en el navegador e intenta reproducir el aspecto que tiene en GitHub. El renderizado se realiza localmente con yuin/goldmark y sus extensiones, por lo que la mayoría de las funciones están disponibles sin conexión a Internet.

Puede ejecutarse como binario independiente o como extensión de GitHub CLI (`gh gfm-preview`). Acepta una ruta de archivo, la entrada estándar o un README que detecta automáticamente en el directorio actual, y permite recargar la página automáticamente cuando cambia el archivo. El modo de listado de directorios permite explorar y previsualizar varios archivos Markdown o de texto.

El proyecto es un fork independiente de gh-markdown-preview, que depende de la API de Markdown de GitHub y, por tanto, requiere acceso a la red. No se admiten las funciones que dependen del acceso a GitHub, como mencionar usuarios o enlazar issues.

Funciones clave

  • 01Renderiza GFM con extensiones locales de goldmark, también sin conexión
  • 02Admite diagramas Mermaid, MathJax, alertas y bloques de código con resaltado de sintaxis
  • 03Recarga automáticamente el navegador cuando cambia el archivo previsualizado
  • 04Acepta rutas de archivos, la entrada estándar o un README detectado automáticamente
  • 05Modo de listado de directorios para explorar y previsualizar varios archivos
  • 06Se ejecuta como binario independiente o como extensión de GitHub CLI

Casos de uso

  • Previsualizar borradores de README o documentación antes de subirlos a GitHub
  • Previsualizar Markdown desde un editor como Neovim mediante un atajo de teclado
  • Escribir Markdown en equipos sin acceso fiable a Internet

Inicio rápido

  1. 1

    Instalar como extensión de GitHub CLI

    gh extension install thiagokokada/gh-gfm-preview
  2. 2

    Previsualizar un archivo Markdown en el navegador

    gh gfm-preview README.md

Antes de usarlo

  • Los diagramas GeoJSON/TopoJSON y las funciones de mapas requieren conexión a internet. No se admiten los diagramas 3D STL.
  • No están disponibles las menciones, las referencias a issues y pull requests ni otras funciones que dependen de GitHub.
  • El renderizado es una emulación, por lo que se parece al resultado de GitHub, pero no es idéntico.

Temas

#markdown#cli#gfm#golang#offline#preview#gh-extension#go

Preguntas frecuentes

¿Qué es gh-gfm-preview?
Una CLI de Go y extensión de GitHub CLI que inicia un servidor web local para previsualizar GitHub Flavored Markdown, incluso sin conexión. gh-gfm-preview inicia un servidor web local que muestra un archivo Markdown en el navegador e intenta reproducir el aspecto que tiene en GitHub. El renderizado se realiza localmente con yuin/goldmark y sus extensiones, por lo que la mayoría de las funciones están disponibles sin conexión a Internet.
¿gh-gfm-preview es gratuito? ¿Qué licencia tiene?
gh-gfm-preview es open source bajo la licencia MIT. Revisa los términos de la licencia antes de usarlo en productos comerciales.
¿gh-gfm-preview sigue mantenido?
Actualizado en los últimos 6 meses. El último commit de gh-gfm-preview fue el 24 jul 2026.
¿Para qué puedo usar gh-gfm-preview?
Previsualizar borradores de README o documentación antes de subirlos a GitHub Previsualizar Markdown desde un editor como Neovim mediante un atajo de teclado Escribir Markdown en equipos sin acceso fiable a Internet
¿Cómo se instala gh-gfm-preview?
Instalar como extensión de GitHub CLI: gh extension install thiagokokada/gh-gfm-preview Previsualizar un archivo Markdown en el navegador: gh gfm-preview README.md
¿Dónde consigo gh-gfm-preview?
El código fuente y las instrucciones de instalación están en GitHub: https://github.com/thiagokokada/gh-gfm-preview

Resumen generado por IA a partir del README del proyecto. Las estadísticas de GitHub se actualizan a diario.

Proyectos relacionados