Skip to main content

Guia de início rápido de gravação no GitHub

Conheça os recursos avançados de formatação criando um LEIAME para seu perfil do GitHub.

Introdução

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 tags HTML adicionais, para formatar a escrita no GitHub, em locais como LEIAMEs do repositório e comentários sobre solicitações de pull e problemas. Neste guia, você aprenderá alguns recursos avançados de formatação criando ou editando um LEIAME do seu perfil do GitHub.

Se você é novo em Markdown, pode começar com o curso "Sintaxe básica de escrita e formatação" ou com o curso Comunicar usando Markdown do GitHub 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 obter mais informações, confira "Como criar gists".

Como criar ou editar o perfil LEIAME

O LEIAME do perfil permite compartilhar informações sobre si mesmo com a comunidade em your GitHub Enterprise Server instance. O LEIAME é exibido na parte superior da página de perfil.

Se você ainda não tem um LEIAME de perfil, adicione-o.

  1. Crie um repositório com o mesmo nome que o do usuário do GitHub, inicializando o repositório com um arquivo README.md. Para obter mais informações, confira "Como gerenciar o LEIAME do seu perfil".
  2. 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.

  1. No canto superior direito de qualquer página do GitHub Enterprise Server, clique na foto do seu perfil e clique em Seu perfil.

  2. Clique no ao lado do LEIAME do perfil.

    Captura de tela de uma página de perfil, com o ícone de lápis realçado ao lado do LEIAME do perfil

Como adicionar uma imagem adequada para os visitantes

Você pode incluir imagens em sua comunicação no GitHub. 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 obter mais informações, confira "Como gerenciar suas configurações de tema".

  1. Copie e cole a marcação a seguir no 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>
  2. 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 recurso prefers-color-scheme.
  3. 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.

  4. Para verificar se a imagem foi renderizada corretamente, clique na guia Visualização.

Para obter mais informações sobre o uso de imagens em Markdown, confira "Sintaxe básica de escrita e formatação".

Exemplo

<picture>
  <source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/25423296/163456776-7f95b81a-f1ed-45f7-b7ab-8fa810d529fa.png">
  <source media="(prefers-color-scheme: light)" srcset="https://user-images.githubusercontent.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.githubusercontent.com/25423296/163456779-a8556205-d0a5-45e2-ac17-42d089e3c3f8.png">
</picture>

A aparência

Captura de tela da guia Visualização no modo claro, com a imagem de um sol sorridente exibida

Como adicionar uma tabela

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.

  1. Retorne à guia Editar arquivo.

  2. 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 GitHub's mascot.
    
  3. 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|               |
  4. Na coluna à direita, substitua THING-TO-RANK por "Idiomas", "Hobbies" ou qualquer outra coisa, e preencha a coluna com sua lista de itens.

  5. Para verificar se a tabela foi renderizada corretamente, clique na guia Visualização.

Para obter mais informações, confira "Como organizar informações com tabelas".

Exemplo

## About me

Hi, I'm Mona. You might recognize me as GitHub's mascot.

| Rank | Languages |
|-----:|-----------|
|     1| Javascript|
|     2| Python    |
|     3| SQL       |

A aparência

Captura de tela da guia Visualização, mostrando um título "Sobre mim" e uma tabela renderizada com uma lista de idiomas

Com adicionar uma seção recolhida

Para manter o conteúdo organizado, você pode usar a tag <details> para criar uma seção recolhida expansível.

  1. 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>
  2. Entre as tags <summary>, substitua THINGS-TO-RANK pelo que você classificou na tabela.

  3. Opcionalmente, para que a seção seja exibida como aberta por padrão, adicione o atributo open à tag <details>.

    <details open>
    
  4. Para verificar se a seção recolhida foi renderizada corretamente, clique na guia Visualização.

Exemplo

<details>
<summary>My top languages</summary>

| Rank | Languages |
|-----:|-----------|
|     1| Javascript|
|     2| Python    |
|     3| SQL       |
  
</details>

A aparência

Captura de tela da guia Visualização, com uma seção recolhida chamada "Meus idiomas principais" marcada por uma seta suspensa

Como adicionar uma citação

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.

  1. Na parte inferior do arquivo, duas linhas abaixo da tag </details>, adicione uma regra horizontal digitando três ou mais traços.

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

  3. Para verificar se tudo foi renderizado corretamente, clique na guia Visualização.

Exemplo

---
> If we pull together and commit ourselves, then we can push through anything.

— Mona the Octocat

A aparência

Captura de tela da guia Visualização, com uma citação recuada abaixo de uma linha horizontal grossa

Como adicionar um comentário

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.

  1. 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).

  2. Para verificar se o comentário está oculto na saída, clique na guia Visualização.

Exemplo

## About me

<!-- TO DO: add more details about me later -->

Salvando seu trabalho

Quando estiver satisfeito com as alterações, salve o LEIAME do perfil clicando em Fazer commit de 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.

Captura de tela da seção "Fazer commit de alterações"

Próximas etapas