Esta versão do GitHub Enterprise será descontinuada em 2022-02-16. Nenhum lançamento de patch será feito, mesmo para questões críticas de segurança. Para obter melhor desempenho, melhorar a segurança e novos recursos, upgrade to the latest version of GitHub Enterprise. Para ajuda com a atualização, contact GitHub Enterprise support.

Trabalhar com arquivos que não envolvem código

GitHub Enterprise Server supports rendering and diffing in a number of non-code file formats.

Renderizar e comparar imagens

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

Observação: os arquivos SVGs no GitHub podem não renderizar no navegador Firefox.

Exibir imagens

Você pode procurar e exibir imagens diretamente no repositório do GitHub Enterprise Server:

imagem inline

No momento, os arquivos SVGs não são compatíveis com animação ou scripts inline.

Exibir diferenças

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

2-up

2-up é o modo 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 facilita identificar quando as imagens foram redimensionadas, como quando ativos são atualizados em resoluções mais altas.

2-up

Deslizar

O modo deslizar permite ver partes da imagem lado a lado. Não sabe se houve mudança de cor nas versões? Posicione o controle deslizante sobre a área em questão e compare os pixels.

Deslizar

Exibição em camadas

A exibição em camadas é muito útil para identificar movimentações sutis dos elementos. Um ícone foi movimentado dois pixels para a esquerda? Arraste o controle deslizante de opacidade um pouco e observe se as coisas se movem.

Exibição em camadas

Visualizador de arquivos 3D

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

Diretamente em um arquivo STL no GitHub Enterprise Server, você pode:

  • 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.

Diffs

Em um commit ou conjunto de alterações que inclui um arquivo STL, você poderá ver um diff antes e depois do arquivo.

Por padrão, você obterá uma exibição em que tudo que permanecer inalterado estará em wireframe. As adições recebem a cor verde e as partes removidas ficam em vermelho.

wireframe

Também é possível selecionar a opção Revision Slider (Controle deslizante de revisão), que permite usar um controle deslizante na parte superior do arquivo para fazer a transição entre as revisões atuais e anteriores.

Corrigir desempenho lento

Caso você veja este ícone no canto do visualizador, isso significa que a tecnologia WebGL não está disponível no seu navegador:

Erro exibido para WebGL

A WebGL é necessária para o aproveitamento completo do hardware do computador. Sugerimos testar os navegadores Chrome ou Firefox, que já vêm com a WebGL habilitada.

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

Se o seu modelo não for válido, o GitHub talvez não consiga exibir o arquivo. Além disso, os arquivos com mais de 10 MB são grandes demais para exibição no GitHub.

Incorporar o modelo em outro lugar

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 fosse github.com/skalnik/secret-bear-clip/blob/master/stl/clip.stl, seu código de incorporação seria:

<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 passando as variáveis de altura e largura como parâmetros no fim da URL, como height=300&width=500.

Observação: ref pode ser um branch ou o hash para um commit individual (como 2391ae).

Renderizar dados CSV e TSV

O GitHub oferece suporte à renderização de dados tabulares na forma de arquivos .csv (separados por vírgula) e .tsv (separados por tubulação).

Arquivo CSV de amostra renderizado

Quando visualizados, os arquivos .csv ou .tsv presentes em um commit para um repositório do GitHub Enterprise Server são renderizados como uma tabela interativa completa, com cabeçalhos e numeração da linha. 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:

Pesquisa de valores

Como lidar com erros

Ocasionalmente, você pode identificar que seu arquivo CSV ou TSV não está renderizando. Nesse caso, uma caixa de erro será exibida na parte inferior do texto bruto sugerindo o motivo do erro.

Mensagem de erro de renderização do arquivo CSV

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.

Renderizar documentos PDF

O GitHub oferece suporte à renderização de documentos PDF.

Documento PDF renderizado

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

Renderizar diferenças em documentos em prosa

Commits e pull requests que incluem documentos de prosa podem representar esses documentos com as exibições source (original) e rendered (renderizada).

A exibição original mostra o texto bruto que foi inserido, enquanto a exibição renderizada mostra como o texto será exibido após a renderização no GitHub Enterprise Server. Por exemplo, há uma diferença na exibição do **bold** no Markdown e do bold in na visualização renderizada.

A renderização da prosa é possível para documentos renderizados compatíveis com o github/markup:

  • markdown
  • AsciiDoc
  • Textile
  • ReStructuredText
  • Rdoc
  • Org
  • Creole
  • MediaWiki
  • Pod

Ícone de papel para exibir documento em prosa renderizado

Você pode clicar em para ver as alterações feitas no documento como parte de um commit.

Alterações em prosa renderizada

Exibir alterações nos atributos

Nós fornecemos uma dica de ferramenta descrevendo as alterações nos atributos, que diferentes de palavras, não seriam visíveis no documento renderizado. Por exemplo, se a URL de um link for alterada, mostraremos uma dica de ferramenta como esta:

Alterações no atributo de prosa renderizada

Fazer comentários em alterações

Os comentários de commit comments só podem ser adicionados aos arquivos na exibição original, linha por linha.

Vincular a cabeçalhos

Assim como ocorre em outros documentos de prosa renderizados, posicionar o mouse sobre um cabeçalho no documento cria um ícone de link. Você pode encaminhar os leitores do seu diff de prosa renderizado a seções específicas.

Exibir diffs complexos

Algumas pull requests envolvem um grande número de alterações e documentos grandes e complexos. Quando as mudanças levam muito tempo para serem analisadas, GitHub Enterprise Server não pode produzir uma visão renderizada das alterações. Se isso acontecer, você verá uma mensagem de erro ao clicar no botão renderizado.

Mensagem quando a visualização não pode ser renderizada

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 Enterprise Server, parte do HTML integrado pode ser mostrado em uma pré-visualização, enquanto outra parte (como um vídeo integrado do YouTube) não.

Em geral, as exibições renderizadas de alterações em um documento que contém HTML integrado mostrarão as alterações nos elementos que são compatíveis com a exibição do GitHub Enterprise Server do documento. As alterações em documentos que contém HTML integrado devem sempre ser confirmadas nas exibições original e renderizada.

Mapping geoJSON files on GitHub

O GitHub Enterprise Server é compatível com a renderização de arquivos de mapas geoJSON e topoJSON nos repositórios do GitHub Enterprise Server. Simplesmente faça o commit do arquivo como você faria normalmente usando uma extensão .geojson ou .topojson. Arquivos com a extensão .json também são compatíveis, mas somente se o type (tipo) for configurado para FeatureCollection (Coleção de elementos gráficos), GeometryCollection (Coleções geométricas) ou topology (topologia). Depois, navegue para o caminho do arquivo geoJSON em GitHub.com.

Quando você clicar no ícone de folha de papel à direita, também verá as alterações feitas naquele arquivo como parte de um commit.

Captura de tela seletor Source Render (Renderizar fonte)

Tipos geométricos

Os mapas no GitHub Enterprise Server usam Leaflet.js e são compatíveis com todos os tipos geométricos descritos nas especificações geoJSON (Ponto, LineString, Polígono, Múltiplos Pontos, MultiLineString, MultiPolygon e GeometryCollection). Os arquivos TopoJSON devem ser do tipo "Topology" (Topologia) e estar de acordo com as especificações topoJSON.

Estilos de elementos gráficos

Você pode personalizar a maneira como os elementos gráficos são exibidos, como especificar uma cor ou adicionar um ícone descritivo, transmitindo metadados adicionais nas propriedades do objeto geoJSON. As opções são:

  • marker-size (marcador de tamanho) - small (pequeno), medium (médio) ou large (grande)
  • marker-color (marcador de cores) Válido para cores RGB e hexadecimal
  • marker-symbol (marcador de símbolos) - um ícone ID do projeto Maki ou um caractere alfanumérico único (a-z ou 0-9).
  • stroke (traço) - cor da borda ou linha de um polígono (RGB)
  • stroke-opacity (opacidade do traço) - opacidade de uma borda ou linha de um polígono (0,0 - 1,0)
  • stroke-width (largura do traço) - largura da linha ou borda de um polígono
  • fill (preenchimento) - a cor do interior de um polígono (RGB)
  • fill-opacity (opacidade do preenchimento) - opacidade do interior de um polígono (0,0 - 1,0)

Consulte a versão 1.1.0 do simplestyle especificações de código aberto para obter mais informações.

Incorporar o mapa em outro lugar

Você quer deixar o seu mapa geoJSON disponível em outro lugar além do GitHub Enterprise Server? Simplesmente modifique este modelo e coloque-o em qualquer página HTML compatível com 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 de seu mapa é github.com/benbalter/dc-wifi-social/blob/master/bars.geojson, o código de incorporação será:

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

Por padrão, o mapa incorporado tem 420px x 620px, mas é possível personalizar a saída passando 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 o hash para um commit individual (como 2391ae).

Clustering

Se o seu mapa contém um número grande de marcadores (aproximadamente mais de 750), em níveis de zoom maiores, o GitHub automaticamente fará cluster de marcadores próximos. Simplesmente clique em cluster ou aumentar o zoom para ver os marcadores individuais.

Algo errado no mapa de base

Os dados do mapa de base (nomes de ruas, estradas etc) são determinados pelo OpenStreetMap, um projeto colaborativo para criação de um mapa do mundo grátis e editável. Por ser de código aberto, se você observar que alguma coisa não está certa, simplesmente inscreva-se e envie uma correção.

Solução de Problemas

Se você está com problemas para renderizar arquivos geoJSON, certifique-se de que tem um arquivo geoJSON 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 é compatível atualmente. No momento, o GitHub Enterprise Server somente é compatível com a projeção urn:ogc:def:crs:OGC:1.3:CRS84.

Além disso, se o seu arquivo .geojson for particularmente grande (acima de 10 MB), não é possível renderizar no navegador. Se esse for o caso, você normalmente verá uma mensagem parecida com esta:

Arquivo grande

Ainda pode ser possível renderizar os dados convertendo o arquivo .geojson em TopoJSON, um formato compactado que pode reduzir o tamanho dos arquivos em até 80%, em alguns casos. 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.

Recursos adicionais

Working with Jupyter Notebook files on GitHub

When you add Jupyter Notebook or IPython Notebook files with a .ipynb extension on sua instância do GitHub Enterprise Server, they will render as static HTML files in your repository.

Os recursos interativos do notebook, como plots personalizados de JavaScript, não funcionam no seu repositório no sua instância do GitHub Enterprise Server. Para ver um exemplo, consulte Linking e Interactions.ipynb.

Para exibir o Jupyter Notebook com conteúdo JavaScript renderizado ou compartilhar arquivos do seu notebook com outras pessoas, use nbviewer. Para ver um exemplo, consulte Linking e Interactions.ipynb representados no nbviewer.

Para exibir uma versão totalmente interativa do Jupyter Notebook, configure um servidor de notebook localmente. Para obter mais informações, consulte a documentação oficial do Jupyter.

Solução de Problemas

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

$ jupyter nbconvert --to html NOTEBOOK-NAME.ipynb

Leia mais

Esse documento ajudou você?

Política de Privacidade

Ajude-nos a tornar esses documentos ótimos!

Todos os documentos do GitHub são de código aberto. Você percebeu que algo que está errado ou não está claro? Envie um pull request.

Faça uma contribuição

Ou, aprenda como contribuir.