Repolode
Enviar
thiagokokada

thiagokokada/gh-gfm-preview

Uma CLI em Go e extensão do GitHub CLI que inicia um servidor web local para visualizar Markdown no estilo do GitHub, inclusive offline.

Alternativa open source a:GitHub Markdown preview

Ver no GitHub
Estrelas
133
Forks
4
Issues abertas
0
Último commit
há 3 meses

O que é?

gh-gfm-preview inicia um servidor web local que renderiza um arquivo Markdown no navegador, com o objetivo de reproduzir a aparência do Markdown no GitHub. A renderização é feita localmente com yuin/goldmark e suas extensões, então a maioria dos recursos funciona sem conexão com a internet.

Pode ser executado como um binário independente ou como uma extensão do GitHub CLI (`gh gfm-preview`). Aceita um caminho de arquivo, entrada padrão ou um README detectado automaticamente no diretório atual, além de atualizar a página ao vivo quando o arquivo muda. O modo de listagem de diretórios permite navegar e visualizar vários arquivos Markdown ou de texto.

O projeto é um fork não oficial do gh-markdown-preview, que depende da API de Markdown do GitHub e, por isso, precisa de acesso à rede. Recursos que dependem do acesso ao GitHub, como mencionar usuários ou criar links para issues, não são compatíveis.

Recursos principais

  • 01Renderiza GFM com extensões locais do goldmark, funcionando offline
  • 02Oferece suporte a diagramas Mermaid, MathJax, alertas e blocos de código com realce de sintaxe
  • 03Atualiza o navegador ao vivo quando o arquivo visualizado muda
  • 04Aceita caminhos de arquivos, entrada padrão ou um README detectado automaticamente
  • 05Modo de listagem de diretórios para navegar e visualizar vários arquivos
  • 06Pode ser executado como binário independente ou extensão do GitHub CLI

Casos de uso

  • Visualizar rascunhos de README ou documentação antes de enviá-los ao GitHub
  • Visualizar Markdown de um editor como o Neovim usando um mapeamento de tecla
  • Escrever Markdown em máquinas sem acesso confiável à internet

Início rápido

  1. 1

    Instalar como extensão da GitHub CLI

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

    Visualizar um arquivo Markdown no navegador

    gh gfm-preview README.md

Antes de usar

  • Diagramas GeoJSON/TopoJSON e recursos de mapas precisam de conexão com a internet. Diagramas 3D STL não são compatíveis.
  • Menções, referências a issues e pull requests e outros recursos que dependem do GitHub não estão disponíveis.
  • A renderização é uma emulação: é semelhante à do GitHub, mas não idêntica.

Tópicos

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

Perguntas frequentes

O que é gh-gfm-preview?
Uma CLI em Go e extensão do GitHub CLI que inicia um servidor web local para visualizar Markdown no estilo do GitHub, inclusive offline. gh-gfm-preview inicia um servidor web local que renderiza um arquivo Markdown no navegador, com o objetivo de reproduzir a aparência do Markdown no GitHub. A renderização é feita localmente com yuin/goldmark e suas extensões, então a maioria dos recursos funciona sem conexão com a internet.
gh-gfm-preview é gratuito? Qual é a licença?
gh-gfm-preview é open source sob a licença MIT. Confira os termos da licença antes de usá-lo em produtos comerciais.
gh-gfm-preview ainda é mantido?
Atualizado nos últimos 6 meses. O último commit de gh-gfm-preview foi em 24 de jul. de 2026.
Para que posso usar gh-gfm-preview?
Visualizar rascunhos de README ou documentação antes de enviá-los ao GitHub Visualizar Markdown de um editor como o Neovim usando um mapeamento de tecla Escrever Markdown em máquinas sem acesso confiável à internet
Como instalar gh-gfm-preview?
Instalar como extensão da GitHub CLI: gh extension install thiagokokada/gh-gfm-preview Visualizar um arquivo Markdown no navegador: gh gfm-preview README.md
Onde consigo gh-gfm-preview?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/thiagokokada/gh-gfm-preview

Resumo gerado por IA a partir do README do projeto. As estatísticas do GitHub são atualizadas diariamente.

Projetos relacionados