Adicionar um link para editar no GitHub
O link Editar no GitHub aparece na parte inferior de todas as páginas do seu site do Docsbook e abre o arquivo de origem dessa página no editor do GitHub. Um leitor que encontrar um erro de digitação pode corrigi-lo e abrir uma pull request sem saber nada sobre o Docsbook.
Procurando outra coisa? Esta página aborda o link de edição voltado para o leitor. Para conectar uma conta do GitHub ou mover um projeto hospedado no Docsbook para um repositório que você possui, abra o seletor de projetos no cabeçalho do chat de IA e use Repositório conectado — consulte Início rápido.
O que as duas configurações fazem#
| Configuração | O que faz |
|---|---|
| Mostrar "Editar no GitHub" | Adiciona o link de edição na parte inferior de cada página |
| URL base de edição do GitHub | O caminho base a partir do qual o link é construído |
Ativar o link de edição#
- Abra o site da documentação enquanto estiver conectado.
- Abra a aba Float Widget → Design → Content.
- Ative Mostrar "Editar no GitHub".
- Defina a URL base de edição do GitHub — consulte a próxima seção.
- Clique em Salvar.
Definir a URL base de edição do GitHub#
A URL base de edição informa ao Docsbook para onde enviar um leitor que clicar no link. O Docsbook acrescenta o caminho da página atual a ela.
https://github.com/YOUR_USERNAME/YOUR_REPO/edit/YOUR_BRANCH/YOUR_DOCS_FOLDEREscolha a linha que corresponde ao local onde seu markdown está:
| Repositório | Localização da documentação | URL base de edição |
|---|---|---|
myname/my-repo |
Raiz do repositório | https://github.com/myname/my-repo/edit/main |
myname/my-repo |
Pasta /docs |
https://github.com/myname/my-repo/edit/main/docs |
myname/my-repo |
Ramificação master |
https://github.com/myname/my-repo/edit/master |
Deixe o campo vazio e o Docsbook criará o link a partir do repositório que você conectou.
Quando ativá-lo#
Para um projeto de código aberto, o link de edição é o caminho de contribuição mais simples que você pode oferecer: um leitor corrige uma flag incorreta ou um número de versão desatualizado no navegador, e você recebe uma pull request em vez de uma issue.
Para a documentação interna da equipe, ele permite que qualquer pessoa da equipe proponha uma alteração de redação sem precisar aprender a usar a interface do Docsbook — basta editar o arquivo no GitHub e o site acompanha a alteração.
O link de edição não chama nenhum modelo de IA, portanto não consome o saldo do seu projeto.
Próximos passos#
- Opções de conteúdo — os outros controles na mesma aba Design.
- Gerencie seu site de documentação — como uma edição no GitHub chega ao seu site ativo.
Todo novo projeto começa com US$ 1 de saldo, e o link de edição não o utiliza.