Asp.Net C ++ C# CSS Desenvolvimento Desenvolvimento de jogos Desenvolvimento Desktop Desenvolvimento Mobile Desenvolvimento Web HTML Java Javascript JQuery Linguagens de programação Node.js Notícias PHP Python React WordPress

Como criar um README excelente no GitHub

Git e GitHub - Guia prático

O post Como criar um README excelente no GitHub demonstra como fazer um README.md excelente para seus projetos armazenados na plataforma GitHub. O post abordara sobre markdown, formatação, imagens, GIFs, links, listas, quotes, tasklists e muito mais.

Como criar um README excelente no GitHub

O que é o README

O README é uma linguagem marcação, assim como HTML e serve basicamente para estilizarmos texto na web. Sua extensão é .md justamente para indicar que o mesmo é um arquivo de marcação.

Sintexe e seus equivalentes em HTML

Header (equivalente aos <h1><h2><h3>)

Ênfase (equivalente ao negrito <b>, itálico <i> e riscado <strike>)

Lista Ordenada (equivalente ao <ol>)

Lista Não Ordenada (equivalente ao <ul>)

Links (equivalente ao <a>)

Quotes (equivalente ao <blockquote>)

Tasklists

Código

Tabelas

Em markdown temos que basicamente desenhar a tabela, porém existe um gerador de tabelas que facilita a nossa vida: gerador
Basta copiar o que o gerador criar e colar no README.md.

Em HTML usamos a nossa conhecida <table>:

Imagens e Gifs

Ensinarei duas maneiras, a maneira “espertinha” (e que eu não recomendo tanto) e a maneira mais “correta”. Faça como achar melhor.

Primeiro a maneira “espertinha”. Vamos em New Issue e jogamos a imagem lá, o GitHub hospeda e já converte em um link certinho, basta copiarmos e jogarmos no README.md, se liga só:

E agora uma maneira mais controlada. Tendo a imagem que queremos em um diretório do nosso repositório, basta usar a seguinte sintaxe:

Em markdown: ![](caminho até a imagem)

Em HTML: <img src=”caminho até a imagem”>
Com a tag HTML também podemos usar os atributos height e width para alterar o tamanho 😀

Ambas as maneiras funcionam com links externos, vamos a alguns exemplos de sintaxe:

Para criar parágrafos basta dar um enter entre as linhas e para pular a linhar colocar dois espaços em branco no final da linha.

fonte: midium.com

Inscreva-se para receber em seus e-mais as notícias do nosso site

Leia as notícias de Presidente Prudente e região.

Grupos de Estudo

Participe de nossos grupos de estudo e compartilhe suas dúvias e conhecimentos com a nossa comunidade de desenvolvedores.

Whatsapp group
Logo facebook
Grupo Privado · 1.072 membros
Participar do grupo

Quer aprender a programar?