English version here.
Introdução
O Github é um dos serviços mais utilizados por desenvolvedores em todo o mundo, ou como o próprio slogan diz "Onde o mundo constrói seus softwares".
Porém, além de todas as funcionalidades que você já deve conhecer, o Github pode também ser considerado uma rede social para desenvolvedores e, como toda rede social, é interessante ter um bom perfil inicial, para que as pessoas possam te conhecer melhor logo no primeiro acesso.
Para isso, seu perfil pode possuir um "profile readme", um arquivo com o seu nome que será exibido em sua página inicial, ele é totalmente customizável, visto que é um arquivo Markdown que suporta tags HTML e outros recursos.
Hoje vou mostrar a vocês como podemos criar um README bem legal com diversas integrações e funcionalidades, assim como o meu.
OBS.: Existem inúmeros recursos que podem ser adicionados ao seu README, irei explicar apenas alguns que utilizo ou utilizei, mas deixarei links para todos os outros.
Mão na Massa
Para ativar esse recurso em seu perfil, basta criar um repositório com o mesmo nome do seu perfil (seu @ no caso), e criar um arquivo README.md dentro dele, dessa forma:
Feito isso, abra o arquivo que criou, no editor do Github mesmo, e começaremos a editar. Caso não tenha experiência em arquivos Markdown, pode acessar a esse guia da linguagem e acompanhar por ele, é bem tranquilo.
Existem milhares de modelos e maneiras de criar seu README, deixarei abaixo alguns repositórios com ideias que podem te inspirar:
Awesome GitHub Profile README Template Collection
Alguns são bem simples e objetivos, outros são mais completos e cheios de recursos, veremos alguns deles a seguir.
Badges
Você pode adicionar Badges ao seu perfil, para representar suas redes sociais, tecnologias que domina ou está aprendendo, projetos e estados de projetos e diversas outras coisas.
O melhor site para gerar e adicionar essas badges, é o Shields.io. Nele você pode criar e editar suas próprias badges, ou selecionar alguma já pronta.
Existe também 2 repositórios muito interessantes, com badges prontas e em um sistema de copia e cola:
Markdown Badges do Ileriayo Adebiyi
Você também pode adicionar suas tecnologias e ferramentas de interesse/domínio como simples imagens, para isso existem os repositórios:
Todas as opções vão gerar uma linha de código, basta inserir no seu arquivo README.
Stats
Outra opção legal de adicionar em seu perfil, são as estatísticas de linguagens utilizadas, número de commits, repositórios, pull requests e afins.
Assim como as badges, basta adicionar um linha de código em seu perfil README, seguindo os repositórios abaixo e adicionando seu @, para que suas estatísticas sejam geradas:
GitHub Readme Stats do Anurag Hazra
Waka Readme Stats do Anmol Pratap Singh - Necessário criar uma conta
Integrações
Além de "decorações" e estilos, você também pode integrar outros serviços em seu perfil, deixarei abaixo os mais comuns e populares:
Discord - Discord Banner - você precisará acessar seu perfil no discord, ativar o modo desenvolvedor e resgatar sua API Key, para fazer essa integração.
Spotify - Spotify Github Profile - basta clicar no botão Connect with Spotify e permitir a integração.
DEV.to - Latest Post
Imagens
Você também pode utilizar imagens e animações em seu perfil, isso pode ser feito utilizando o recurso nativo de imagens do Markdown (basta criar uma basta no seu repositório, adicionar as imagens e referenciar elas). Mas também existem alternativas bem legais para isso:
Pronto, com isso você conseguirá montar um readme show, fique a vontade de compartilhar seu perfil nos comentários.
Espero que tenham gostado, até mais. ✌️
Top comments (0)