Contribuir para a documentação do GitHub Docs
Saiba mais sobre como a equipe do GitHub Docs cria a documentação e como você pode contribuir.
Comece por aqui
Melhores práticas para documentos do GitHub
Siga estas melhores práticas para criar uma documentação fácil de usar e de entender.
Guia de estilo
Siga este guia para garantir que a documentação do GitHub permaneça consistente e siga padrões claros que nossos leitores possam entender.
Sobre o modelo de conteúdo
O modelo de conteúdo descreve a estrutura e os tipos de conteúdo que publicamos.
Sobre a contribuição com o GitHub Docs
Você pode contribuir com o conteúdo do GitHub Docs de várias maneiras.
Como escrever para o GitHub Docs
- Melhores práticas para documentos do GitHub
- Sobre a filosofia de documentação do GitHub
- Sobre os conceitos básicos da documentação do GitHub
- Princípios de design de conteúdo
- Como escrever um conteúdo para tradução
- Tornar o conteúdo localizável na pesquisa
- Documentação de controle de versão
- Como usar Markdown e Liquid no GitHub Docs
- Usar front matter YAML
- Como usar vídeos no GitHub Docs
- Como criar um conteúdo reutilizável
- Como criar capturas de tela
- Criando diagramas para o GitHub Docs
- Como criar alternadores de ferramentas em artigos
- Configurar os redirecionamentos
- Como alterar o título de um artigo
- Anotar exemplos de código
- Modelos
Guia de estilo e modelo de conteúdo
- Guia de estilo
- Sobre o modelo de conteúdo
- Conteúdo de um artigo do GitHub Docs
- Tipo de conteúdo conceitual
- Tipo de conteúdo referencial
- Tipo de conteúdo de procedimento
- Tipo de conteúdo de solução de problemas
- Tipo de conteúdo de notas de versão
- Tipo de conteúdo de início rápido
- Tipo de conteúdo de tutorial
- Sobre a combinação de vários tipos de conteúdo