Guia de README do GitHub

GitHub Profile 3D Contrib: configure um calendario 3D no README

github-profile-3d-contrib e ideal para mostrar um calendario 3D atualizado no README do perfil. Este guia cobre permissoes, pastas de saida, insercao no README, imagens vazias e quando GitHub City e melhor.

Resposta rapida: o que e GitHub Profile 3D Contrib?

GitHub Profile 3D Contrib es una GitHub Action que convierte el calendario de contribuciones en imagenes 3D listas para un perfil. El workflow genera archivos y los confirma para que el README muestre un calendario 3D actualizado.

La intencion es distinta de GitHub City. Quien busca github profile 3d contrib normalmente necesita un archivo YAML, una ruta de imagen y una programacion fiable; quien busca GitHub City suele querer un visualizador online sin editar repositorios.

Usa profile-3d-contrib si la salida debe vivir en el README. Usa GitHub City para explorar en el navegador y la comparacion de herramientas 3D para elegir entre imagenes, ciudades interactivas y modelos.

Para github profile 3d contrib, esta pagina cobre automacao de README, GitHub Actions, arquivos gerados e solucao de problemas. Para digitar um usuario e ver uma cidade online, use GitHub City.

Diagrama que compara calendario 3D para README, GitHub City y GitHub Skyline
profile-3d-contrib automatiza el README; GitHub City explora en navegador; Skyline se orienta a modelos.

Como configurar profile-3d-contrib sem quebrar o README

Comece com a action oficial e verifique cada requisito do GitHub. Uma configuracao pequena, explicita e facil de executar manualmente e mais segura.

1

Crie o repositorio especial de perfil

Crie um repositorio publico com o mesmo nome exato do seu usuario do GitHub.

2

Adicione o workflow

Crie .github/workflows/profile-3d.yml, conceda contents: write e use a action com GITHUB_TOKEN.

3

Execute manualmente uma vez

Use workflow_dispatch na primeira execucao para ver erros de permissao, token ou YAML.

4

Incorpore a imagem gerada

Adicione o caminho SVG ou PNG ao README.md e confira branch, pasta, maiusculas e caminho relativo.

5

Revise contribuicoes privadas

Contribuicoes privadas so aparecem como resumo publico se seu perfil permitir.

Arquivos e ajustes para verificar

La configuracion es pequena, pero depende de una cadena: workflow, carpeta generada, ruta del README y ajustes de perfil.

Si Actions genera archivos pero el README no cambia, el problema suele estar en la ruta, la rama, la cache o la referencia Markdown.

Arquivo ou ajuste Finalidade O que verificar
README.md Mostra o calendario 3D no perfil. O caminho deve bater exatamente com o arquivo commitado.
.github/workflows/profile-3d.yml Executa o gerador por agenda ou manualmente. Inclua permissao de escrita e gatilho manual.
Pasta de saida Armazena os SVG/PNG gerados. Confirme que os arquivos foram commitados.
Ajustes do perfil Controlam resumo publico de atividade privada. Ative apenas se quiser essa exibicao.
Etapa de commit do workflow Grava arquivos SVG ou PNG gerados no repositorio do perfil. Inclua apenas imagens geradas, evite commits vazios e ignore arquivos de cache.

profile-3d-contrib vs GitHub City vs GitHub Skyline

Todos usan datos de contribuciones, pero resuelven trabajos distintos. No elijas solo por la frase grafico 3D.

profile-3d-contrib

Ideal para uma imagem sempre visivel no README. Requer repositorio e Actions.

GitHub City

Ideal para exploracao instantanea em uma cidade 3D no navegador, sem YAML.

GitHub Skyline

Melhor para uma forma 3D ou saida exportavel, nao para README.

Corrigir imagens 3D ausentes ou antigas

Abre primero la ultima ejecucion de Actions. Si fallo, mira permisos, token, YAML o limites. Si paso pero no hay imagen en README, revisa ruta y Markdown.

Si la imagen sale vacia, comparala con el grafico oficial de GitHub. Lo que no aparece ahi normalmente no aparecera en la imagen 3D. Para commits, usa la lista de comprobacion de commits.

Si esta obsoleta, revisa zona horaria del cron, proteccion de rama, push del commit y cache del README.

Se Actions concluir com sucesso mas a imagem parecer antiga, confira o hash do arquivo, o caminho no README e possiveis caches do GitHub ou do navegador.

Antes de trocar de action, registre o que mudou entre duas execucoes: horario do workflow, branch usada, pasta de saida, nome do arquivo e caminho no README. Esse historico simples evita confundir problema de permissao com cache de imagem ou referencia Markdown antiga.

Se você ainda está planejando todo o perfil, use o guia de modelo de GitHub profile README antes de adicionar uma imagem 3D. Para widgets estáticos de README que não são imagens 3D geradas, use o guia de GitHub streak stats em vez de alterar este workflow do Actions.

No depures Git bruto desde un generador de README

profile-3d-contrib visualiza lo que GitHub expone. Corrige emails, ramas, privacidad y reglas de forks antes de cambiar el generador.

FAQ

profile-3d-contrib e igual ao GitHub City?

Nao. profile-3d-contrib gera imagens via Actions; GitHub City e interativo no navegador.

Preciso de GitHub Actions?

Sim. O setup normal usa Actions para regenerar e commitar a imagem.

Por que a imagem 3D esta vazia?

Confira o grafico oficial, permissoes, token, usuario, branch de saida e caminho no README.

Contribuicoes privadas podem aparecer?

Apenas o resumo publico permitido pelo GitHub pode ser refletido.

Qual ferramenta para compartilhar rapido?

GitHub City para vista interativa; profile-3d-contrib para README.

Quais arquivos github-profile-3d-contrib costuma gerar?

Normalmente gera imagens SVG ou PNG do calendario 3D, salvas no repositorio do perfil e referenciadas no README.md.

O que verificar antes de alterar o YAML?

Nome do repositorio do perfil, permissoes do Actions, pasta de saida, branch, caminho no README, usuario e atividade visivel no GitHub.

Fontes e leituras uteis