O Markdown é uma linguagem fácil de ler e de gravar para formatar texto sem formatação. Você pode usar a sintaxe Markdown, juntamente com algumas marcas HTML adicionais, para formatar a gravação em , em locais como LEIAMEs do repositório e comentários sobre pull requests e issues. Neste guia, você aprenderá alguns recursos avançados de formatação criando ou editando um LEIAME do seu perfil do .
Se você é um usuário iniciante do Markdown, o ideal é começar com o curso Sintaxe básica de gravação e formatação no ou Comunicar-se usando o Markdown do Skills.
Se você já tiver um LEIAME do perfil, poderá seguir este guia adicionando alguns recursos ao LEIAME existente ou criando um gist com um arquivo Markdown nomeado de modo semelhante a about-me.md
. Para saber mais, confira Criar gists.
Seu perfil no README permite compartilhar informações sobre você com a comunidade em . O LEIAME é exibido na parte superior da página de perfil.
Se você ainda não tem um LEIAME de perfil, adicione-o.
- Crie um repositório com o mesmo nome que o do usuário do , inicializando o repositório com um arquivo
README.md
. Para saber mais, confira Gerenciar o README do seu perfil. - Edite o arquivo
README.md
e exclua o texto do modelo (começando com### Hi there
) que é adicionado automaticamente quando você cria o arquivo.
Se você já tem um LEIAME de perfil, edite-o na página de perfil.
No canto superior direito de qualquer página, selecione a foto do seu perfil e Your profile.
Clique no ao lado do LEIAME do perfil.
Você pode incluir imagens em sua comunicação no . Aqui, você adicionará uma imagem responsiva, como uma faixa, à parte superior do LEIAME do perfil.
Usando o elemento HTML <picture>
com o recurso de mídia prefers-color-scheme
, você pode adicionar uma imagem que muda de acordo com o modo claro ou escuro usado pelo visitante. Para saber mais, confira Gerenciar as configurações de temas.
Copie e cole a seguinte marcação no seu arquivo
README.md
.HTML <picture> <source media="(prefers-color-scheme: dark)" srcset="YOUR-DARKMODE-IMAGE"> <source media="(prefers-color-scheme: light)" srcset="YOUR-LIGHTMODE-IMAGE"> <img alt="YOUR-ALT-TEXT" src="YOUR-DEFAULT-IMAGE"> </picture>
<picture> <source media="(prefers-color-scheme: dark)" srcset="YOUR-DARKMODE-IMAGE"> <source media="(prefers-color-scheme: light)" srcset="YOUR-LIGHTMODE-IMAGE"> <img alt="YOUR-ALT-TEXT" src="YOUR-DEFAULT-IMAGE"> </picture>
Substitua os espaços reservados na marcação pelas URLs das imagens escolhidas. Como alternativa, para experimentar o recurso primeiro, copie as URLs do exemplo abaixo.
- Substitua
YOUR-DARKMODE-IMAGE
pela URL de uma imagem a ser exibida para visitantes que usam o modo escuro. - Substitua
YOUR-LIGHTMODE-IMAGE
pela URL de uma imagem a ser exibida para visitantes que usam o modo claro. - Substitua
YOUR-DEFAULT-IMAGE
pela URL de uma imagem a ser exibida caso nenhuma das outras imagens seja correspondida, por exemplo, se o visitante estiver usando um navegador sem suporte ao recursoprefers-color-scheme
.
- Substitua
Para tornar a imagem acessível a visitantes que estejam usando um leitor de tela, substitua
YOUR-ALT-TEXT
por uma descrição da imagem.Para verificar se a imagem foi renderizada corretamente, clique na guia Visualização.
Para obter mais informações sobre como usar imagens no Markdown, confira Sintaxe básica de gravação e formatação no .
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://user-images.usercontent.com/25423296/163456776-7f95b81a-f1ed-45f7-b7ab-8fa810d529fa.png">
<source media="(prefers-color-scheme: light)" srcset="https://user-images.usercontent.com/25423296/163456779-a8556205-d0a5-45e2-ac17-42d089e3c3f8.png">
<img alt="Shows an illustrated sun in light mode and a moon with stars in dark mode." src="https://user-images.usercontent.com/25423296/163456779-a8556205-d0a5-45e2-ac17-42d089e3c3f8.png">
</picture>
Você pode usar tabelas Markdown para organizar informações. Aqui, você usará uma tabela para se apresentar classificando algo, como as linguagens ou as estruturas de programação que você mais usa, o que está aprendendo no momento ou seus hobbies favoritos. Quando uma coluna de tabela contém números, é bom alinhar a coluna à direita usando a sintaxe --:
abaixo da linha de cabeçalho.
Retorne à guia Editar arquivo .
Para se apresentar, duas linhas abaixo da tag
</picture>
, adicione um cabeçalho## About me
e um parágrafo curto sobre você, como o seguinte.## About me Hi, I'm Mona. You might recognize me as 's mascot.
Duas linhas abaixo desse parágrafo, insira uma tabela copiando e colando a marcação a seguir.
Markdown | Rank | THING-TO-RANK | |-----:|---------------| | 1| | | 2| | | 3| |
| Rank | THING-TO-RANK | |-----:|---------------| | 1| | | 2| | | 3| |
Na coluna à direita, substitua
THING-TO-RANK
por "Idiomas", "Hobbies" ou qualquer outra coisa, e preencha a coluna com sua lista de itens.Para verificar se a tabela foi renderizada corretamente, clique na guia Visualização.
Para saber mais, confira Organizar informações com tabelas.
## About me
Hi, I'm Mona. You might recognize me as 's mascot.
| Rank | Languages |
|-----:|-----------|
| 1| JavaScript|
| 2| Python |
| 3| SQL |
Para manter o conteúdo organizado, você pode usar a tag <details>
para criar uma seção recolhida expansível.
Para criar uma seção recolhida na tabela que você criou, coloque-a entre tags
<details>
, como no exemplo a seguir.HTML <details> <summary>My top THINGS-TO-RANK</summary> YOUR TABLE </details>
<details> <summary>My top THINGS-TO-RANK</summary> YOUR TABLE </details>
Entre as tags
<summary>
, substituaTHINGS-TO-RANK
pelo que você classificou na tabela.Opcionalmente, para que a seção seja exibida como aberta por padrão, adicione o atributo
open
à tag<details>
.<details open>
Para verificar se a seção recolhida foi renderizada corretamente, clique na guia Visualização.
<details>
<summary>My top languages</summary>
| Rank | Languages |
|-----:|-----------|
| 1| JavaScript|
| 2| Python |
| 3| SQL |
</details>
O Markdown tem muitas outras opções para formatar o conteúdo. Aqui, você adicionará uma regra horizontal para dividir a página e um blockquote para formatar sua cotação favorita.
Na parte inferior do arquivo, duas linhas abaixo da tag
</details>
, adicione uma regra horizontal digitando três ou mais traços.---
Abaixo da linha
---
, adicione uma citação digitando a marcação como a seguir.> QUOTE
Substitua
QUOTE
por uma citação da sua escolha. Como alternativa, copie a citação do exemplo abaixo.Para verificar se tudo foi renderizado corretamente, clique na guia Visualização.
---
> If we pull together and commit ourselves, then we can push through anything.
— Mona the Octocat
Você pode usar a sintaxe de comentário HTML para adicionar um comentário que ficará oculto na saída. Aqui, você adicionará um comentário para se lembrar de atualizar o LEIAME mais tarde.
Duas linhas abaixo do cabeçalho
## About me
, insira um comentário usando a marcação a seguir.<!-- COMMENT -->
Substitua
COMMENT
por um item "pendente" que você quer se lembrar de fazer mais tarde (por exemplo, adicionar mais itens à tabela).Para verificar se o comentário está oculto na saída, clique na guia Visualização.
## About me
<!-- TO DO: add more details about me later -->
Quando estiver satisfeito com as alterações, salve o LEIAME do seu perfil clicando em Confirmar alterações.
Com a confirmação direta no branch main
, suas alterações ficarão visíveis a qualquer visitante no perfil. Se você quiser salvar o trabalho, mas ainda não quiser deixá-lo visível no perfil, selecione Criar um branch para esse commit e iniciar uma solicitação de pull.
- Continue a aprender sobre os recursos de formatação avançada. Por exemplo, confira Criando diagramas e Criar e realçar blocos de código.
- Use suas novas habilidades para se comunicar no , em problemas, solicitações de pull e discussões. Para saber mais, confira Comunicar-se no .