Como trabalhar com arquivos sem código

O GitHub é compatível com a renderização e a diferenciação em diversos formatos de arquivo que não são de código.

Neste artigo

Renderizar e diferenciar imagens

O GitHub pode exibir diversos formatos de imagem comuns, incluindo PNG, JPG, GIF, PSD e SVG. Além de exibir as imagens, existem diversas formas de comparar as diferenças entre as versões desses formatos de imagem.

Observação

  • o GitHub não dá suporte à comparação das diferenças entre arquivos PSD.
  • Caso você esteja usando o navegador Firefox, talvez os SVGs no GitHub não sejam renderizados.

Exibir imagens

Você pode navegar e visualizar imagens diretamente no repositório em GitHub.

No momento, os arquivos SVGs não dão suporte a animação ou scripts embutidos.

Exibir diferenças

Compare imagens visualmente em três modos diferentes: 2-up, deslizar e exibição em camadas.

2-up

O modo 2-up é o padrão: ele fornece uma visão rápida das duas imagens. Além disso, se a imagem tiver mudado de tamanho entre as versões, a alteração real da dimensão será exibida. Isso deve deixar bem claro quando as coisas são redimensionadas, como quando ativos são atualizados para resoluções mais altas.

Captura de tela de uma comparação para uma imagem no modo 2-up. A imagem maior, à direita, está contornada em verde. A imagem à esquerda está contornada em vermelho.

Deslizar

O modo Deslizar permite ver partes da imagem lado a lado. Você está em dúvida se as cores mudaram entre as diferentes versões? Posicione o controle deslizante sobre a área em questão e compare os pixels.

Captura de tela de uma comparação para uma imagem no modo de passar o dedo. Uma linha no centro divide a imagem em nova, contornada em verde, e antiga, contornada em vermelho.

Exibição em camadas

A pele de cebola é realmente útil quando os elementos se movem em quantidades pequenas e difíceis de perceber. Um ícone foi movimentado dois pixels para a esquerda? Arraste o controle deslizante de opacidade um pouco para trás e observe se as coisas se movem.

Visualizador de arquivos 3D

O GitHub pode hospedar e renderizar arquivos 3D com a extensão .stl.

Ao analisar diretamente um arquivo STL no GitHub, o seguinte é possível:

  • Clicar e arrastar para girar o modelo.
  • Clicar com o botão direito do mouse e arrastar para converter a exibição.
  • Rolar para ampliar e reduzir.
  • Clicar nos diferentes modos de exibição para alterar a exibição.

Corrigir desempenho lento

Se você vir no canto do visualizador, com a dica de ferramenta "Suporte de hardware com tecnologia WebGL não disponível", a tecnologia WebGL não estará disponível no navegador.

A WebGL é necessária para o aproveitamento completo do hardware do computador. Recomendamos experimentar navegadores como o Chrome ou o Firefox, que são fornecidos com o WebGL habilitado.

Erro: "Não é possível exibir"

Se o modelo for inválido, GitHub poderá não ser capaz de exibir o arquivo. Além disso, arquivos maiores que 10 MB são grandes demais para GitHub exibir.

Incorporar o modelo em outro contexto

Para exibir o arquivo 3D em outro lugar na Internet, modifique esse modelo e coloque-o em qualquer página HTML que aceite JavaScript:

<script src="https://embed.github.com/view/3d/<username>/<repo>/<ref>/<path_to_file>"></script>

Por exemplo, se a URL do modelo for github.com/skalnik/secret-bear-clip/blob/master/stl/clip.stl, o código de inserção será:

<script src="https://embed.github.com/view/3d/skalnik/secret-bear-clip/master/stl/clip.stl"></script>

Por padrão, o renderizador incorporado tem 420 pixels de largura por 620 pixels de altura, mas você pode personalizar a saída transmitindo as variáveis de altura e largura como parâmetros no final da URL, como ?height=300&width=500.

Observação

          `ref` pode ser um branch ou um hash para um commit individual (como `2391ae`).

Renderização em Markdown

Você pode incorporar a sintaxe do ASCII STL diretamente ao Markdown. Para saber mais, confira Criando diagramas.

Renderizar dados CSV e TSV

GitHub dá suporte à renderização de dados de tabela na forma de arquivos .csv (separados por vírgula) e .tsv (separados por tabulação).

Captura de tela de um arquivo CSV renderizado, com os dados mostrados em um formato de tabela.

Quando visualizado, qualquer arquivo .csv ou .tsv enviado para um repositório em GitHub é renderizado automaticamente como uma tabela interativa, completa com cabeçalhos e numeração de linhas. Por padrão, vamos sempre presumir que a primeira linha é a linha de cabeçalho.

Você pode criar um link para uma linha específica clicando no número da linha ou selecionar várias linhas mantendo a tecla Shift pressionada. Copie e envie a URL para um amigo.

Pesquisar dados

Para encontrar um valor específico no conjunto de dados, comece a inserir o valor na barra de pesquisa logo acima do arquivo. As linhas serão filtradas automaticamente.

Tratar erros

Ocasionalmente, você pode identificar que seu arquivo CSV ou TSV não está renderizando. Nessas situações, uma mensagem é exibida acima do texto bruto, sugerindo o motivo do erro.

Captura de tela de uma exibição de texto de um arquivo CSV. No cabeçalho, uma mensagem aponta um erro: "Nenhuma vírgula encontrada neste arquivo CSV na linha 0".

Os erros comuns incluem:

  • Divergência na contagem de colunas. Você deve ter o mesmo número de separadores em cada linha, mesmo nas células em branco
  • Exceder o tamanho do arquivo. A renderização funciona apenas para arquivos com até 512 KB. Qualquer arquivo maior que isso deixa o navegador lento.
  • Uso de delimitadores sem suporte, como ponto-e-vírgula em vez de vírgula.

Renderizar documentos PDF

GitHub dá suporte à renderização de documentos PDF.

No momento, os links nos PDFs são ignorados.

Renderizar diferenças em documentos em prosa

Os commits e as solicitações de pull que incluem documentos de prosa podem representar esses documentos com as exibições de origem e renderizada.

A exibição de origem mostra o texto bruto que foi digitado, enquanto a visualização renderizada mostra como o texto ficaria depois de ser renderizado no GitHub. Por exemplo, essa pode ser a diferença entre a exibição de **bold** em Markdown e de negrito na exibição renderizada.

Há suporte para a renderização em prosa em documentos renderizados compatíveis com github/markup:

  • Markdown
  • AsciiDoc
  • Têxtil
  • ReStructuredText
  • Rdoc
  • Org
  • Crioulo
  • MediaWiki
  • Pod

Para conferir as alterações feitas no documento como parte de um commit, clique em .

Captura de tela de comparação para um arquivo Markdown. No cabeçalho do arquivo, um ícone de arquivo tem contorno laranja escuro.

Essa "comparação avançada" realça o código que foi adicionado e removido.

Captura de tela do diff para um arquivo Markdown. O texto antigo, "@octo-org/core", é riscado com um fundo vermelho. O novo texto tem um plano de fundo verde.

Desabilitar a renderização do Markdown

Ao visualizar um arquivo Markdown, você pode clicar em Code na parte superior do arquivo para desabilitar a renderização do Markdown e ver a origem do arquivo.

Captura de tela de um arquivo Markdown em um repositório mostrando as opções para interagir com o arquivo. Um botão, rotulado "Código", está destacado em laranja-escuro.

Se você desabilitar a renderização do Markdown, poderá usar recursos de exibição de origem, como vinculação de linha, o que não é possível ao exibir arquivos Markdown renderizados.

Exibir alterações nos atributos

Fornecemos uma dica de ferramenta que descreve as alterações nos atributos que, ao contrário de palavras, não ficarão visíveis no documento renderizado. Por exemplo, se o URL de um link mudar de um site para outro, mostraríamos uma dica de ferramenta como esta: "href: /octo-org-repo/blob/CONTRIBUTING -> /octo-org/octo-repo/blob/docs/CONTRIBUTING."

Captura de tela de comparação para um arquivo Markdown. A dica de ferramenta sobre o link "ARQUIVO CONTRIBUINTE" contém as alterações de URL do exemplo acima.

Fazer comentários sobre alterações

          Os [comentários sobre um commit](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request) só podem ser adicionados aos arquivos na exibição de _origem_, linha a linha.

Vincular a cabeçalhos

Assim como acontece com outros documentos em prosa renderizados, se você posicionar o cursor sobre um cabeçalho no documento, um ícone de link será criado. Você pode vincular os leitores da comparação da prosa renderizada a seções específicas.

Visualizar diferenças complexas

Algumas solicitações de pull envolvem um grande número de alterações e documentos grandes e complexos. Quando as alterações demoram muito para serem analisadas, o GitHub nem sempre consegue produzir uma exibição renderizada delas. Se isso acontecer, você verá uma mensagem de erro ao clicar no botão renderizado.

Você ainda pode usar a exibição original para analisar e comentar as alterações.

Exibir elementos HTML

Não oferecemos suporte direto a exibições renderizadas de commits para documentos HTML. Alguns formatos, como o Markdown, permite a inclusão de HTML arbitrário no documento. Quando esses documentos são mostrados no GitHub, parte do HTML incorporado pode ser visualizada em uma prévia, enquanto outras partes (como um vídeo do YouTube incorporado) não aparecem.

Em geral, as visualizações renderizadas de alterações em um documento que contém HTML incorporado mostrarão alterações nos elementos compatíveis na exibição do documento do GitHub. As alterações em documentos que contêm HTML inserido devem sempre ser revisadas nas exibições de origem e renderizada para garantir a completude.

Mapear arquivos GeoJSON/TopoJSON no GitHub

O GitHub oferece suporte à renderização de arquivos de mapa GeoJSON e TopoJSON em seus repositórios. Faça commit do arquivo como você normalmente faria usando uma extensão .geojson ou .topojson. Também há suporte para arquivos com uma extensão .json, mas somente se type estiver definido como FeatureCollection, GeometryCollection ou topology. Em seguida, acesse o caminho do arquivo GeoJSON/TopoJSON no GitHub.

Tipos de geometria

Os mapas no GitHub usam Leaflet.js e aceitam todos os tipos de geometria descritos na especificação geoJSON (Point, LineString, Polygon, MultiPoint, MultiLineString, MultiPolygon e GeometryCollection). Os arquivos TopoJSON devem ser do tipo "Topology" e aderir à especificação TopoJSON.

Inserir o mapa em outro lugar

Deseja disponibilizar seu mapa GeoJSON em outro lugar que não seja o GitHub? Basta modificar o modelo e colocá-lo em qualquer página HTML que suporte JavaScript, por exemplo, GitHub Pages:

<script src="https://embed.github.com/view/geojson/<username>/<repo>/<ref>/<path_to_file>"></script>

Por exemplo, se a URL do mapa for github.com/benbalter/dc-wifi-social/blob/master/bars.geojson, o código de inserção será:

<script src="https://embed.github.com/view/geojson/benbalter/dc-wifi-social/master/bars.geojson"></script>

Por padrão, o mapa inserido tem 420px x 620px, mas é possível personalizar a saída transmitindo as variáveis de altura e largura como parâmetros no final, como ?height=300&width=500.

Observação

          `ref` pode ser um branch ou um hash para um commit individual (como `2391ae`).

Mapear em Markdown

É possível incorporar GeoJSON e TopoJSON diretamente no Markdown. Para saber mais, confira Criando diagramas.

Agrupamento

Se o mapa contiver um grande número de marcadores (aproximadamente mais de 750), GitHub agrupará automaticamente marcadores próximos em níveis de zoom mais altos. Simplesmente clique no cluster ou dê zoom para ver os marcadores individuais.

Algo está errado com o mapa subjacente

Os dados do mapa subjacentes (nomes de ruas, estradas etc) são determinados pelo OpenStreetMap, um projeto colaborativo para criação de um mapa do mundo gratuito e editável. Se você perceber que algo não está certo, já que é open source, basta sign up e enviar uma correção.

Solução de problemas de arquivos GeoJSON/TopoJSON

Em caso de problemas para renderizar um arquivo GeoJSON, certifique-se de que ele seja válido executando-o por meio de um linter GeoJSON. Se os pontos não estão aparecendo onde deveriam (por exemplo, no meio do oceano), é provável que os dados estejam em uma projeção que não é atualmente suportada. No momento, o GitHub só é compatível com a projeção de urn:ogc:def:crs:OGC:1.3:CRS84.

Além disso, se o arquivo .geojson for particularmente grande (acima de 10 MB), não será possível renderizá-lo no navegador. Se esse for o caso, você geralmente verá uma mensagem informando que não podemos mostrar arquivos tão grandes.

Ainda pode ser possível renderizar os dados convertendo o arquivo .geojson em TopoJSON, um formato de compactação que, em alguns casos, pode reduzir o tamanho do arquivo em até 80%. Claro que você sempre pode quebrar os arquivos em pedaços menores (como por estado ou por ano) e armazenar os dados em vários arquivos no repositório.

Leitura adicional sobre GeoJSON/TopoJSON

  •         [Documentação do Azure Maps](https://docs.microsoft.com/en-us/azure/azure-maps/)

  •         [Wiki do TopoJSON](https://github.com/mbostock/topojson/wiki)

Trabalhando com arquivos Jupyter Notebook no GitHub

Quando você adiciona arquivos Jupyter Notebook ou IPython Notebook com uma extensão .ipynb em GitHub, eles serão renderizados como arquivos HTML estáticos em seu repositório.

Os recursos interativos do notebook, como gráficos personalizados de JavaScript, não funcionarão em seu repositório no GitHub. Para ver um exemplo, confira Linking and Interactions.ipynb.

Para ver o Jupyter Notebook com o conteúdo JavaScript renderizado ou compartilhar os arquivos do notebook com outras pessoas, use o nbviewer. Para ver um exemplo, confira Linking and Interactions.ipynb renderizado no nbviewer.

Para exibir uma versão totalmente interativa do seu Jupyter Notebook, você pode configurar um servidor de notebook localmente. Para obter mais informações, confira a documentação oficial do Jupyter.

Solução de problemas de arquivos Jupyter Notebook

Se você estiver tendo problemas para renderizar arquivos Jupyter Notebook em HTML estático, poderá converter o arquivo localmente na linha de comando usando o comando nbconvert:

jupyter nbconvert --to html NOTEBOOK-NAME.ipynb

Leitura adicional sobre Jupyter Notebook

  •         [repositório do GitHub do Jupyter Notebook](https://github.com/jupyter/jupyter_notebook)

  •         [Galeria de Jupyter Notebooks](https://github.com/jupyter/jupyter/wiki)

Exibindo arquivos do Mermaid em GitHub

O GitHub é compatível com a renderização de arquivos Mermaid em repositórios. Faça commit do arquivo como você normalmente faria usando uma extensão .mermaid ou .mmd. Em seguida, acesse o caminho do arquivo do Mermaid em GitHub.

Por exemplo, se você adicionar um arquivo .mmd com o seguinte conteúdo ao repositório:

graph TD
    A[Friend's Birthday] -->|Get money| B(Go shopping)
    B --> C{Let me think}
    C -->|One| D["Cool <br> Laptop"]
    C -->|Two| E[iPhone]
    C -->|Three| F[fa:fa-car Car]

Ao visualizar o arquivo no repositório, ele é interpretado como um gráfico de fluxo.

Captura de tela de um fluxograma. Duas setas apontam de uma caixa rotulada "A" para caixas rotuladas "B" e "C", e mais duas setas apontam de "B" e "C" para "D".

Solução de problemas de arquivos do Mermaid

Se o gráfico não é renderizado, verifique se ele contém uma sintaxe Markdown válida do Mermaid verificando o gráfico com o editor online do Mermaid.

Se o gráfico for exibido, mas não aparecer como você espera, crie uma GitHub Community discussão de comentários e adicione a marca Mermaid.

Problemas conhecidos

  • Diagramas de sequência frequentemente são renderizados com espaço adicional abaixo do gráfico, com mais espaço sendo adicionado à medida que o tamanho do gráfico aumenta. Este é um problema conhecido com a biblioteca do Mermaid.
  • Os nós do ator com menus popover não funcionam como esperado dentro de gráficos de diagrama de sequência. Isto se deve uma discrepância na forma como eventos do JavaScript são adicionados a um gráfico quando a API da biblioteca do Mermaid é usada para interpretar um gráfico.
  • Nem todos os gráficos são conformes com a11y. Isso pode afetar os usuários que dependem de um leitor de tela.

Mermaid no Markdown

Você pode incorporar a sintaxe do Mermaid diretamente no Markdown. Para saber mais, confira Criando diagramas.

Leitura adicional sobre o Mermaid

  •         [Documentação do Mermaid.js](https://mermaid-js.github.io/mermaid/#/)

  •         [Mermaid.js Live Editor](https://mermaid.live/edit)