1
resposta

[Sugestão] gist responsiveVoice

1 resposta

Olá, Apollo. Como vai?

Essa sua iniciativa de criar e compartilhar um Gist no GitHub é excelente! Você teve uma visão fantástica de comunidade ao documentar a solução para os problemas com a biblioteca responsiveVoice (muito utilizada nos projetos de Lógica de Programação da Alura, como o jogo do Número Secreto).

O GitHub Gist é uma das ferramentas mais fantásticas e subestimadas pelos desenvolvedores. Ele funciona como um bloco de notas público perfeito para compartilhar pequenos trechos de código, scripts de configuração, correções de bugs (hotfixes) ou tutoriais rápidos sem a necessidade de criar um repositório completo com toda a estrutura do Git.

Para agregar ainda mais valor à sua postagem e parabenizar o seu papel de ajudar os colegas no fórum, trago duas dicas de ouro para você extrair o máximo do potencial dos Gists no seu portfólio profissional:


1. Transforme seu Gist em um Mini-Artigo com Markdown

O seu Gist atual contém um script de correção direto. Uma boa prática de documentação é renomear o arquivo do seu Gist (ou adicionar um segundo arquivo no mesmo Gist) com a extensão .md (Markdown).

Isso permite que você escreva uma explicação formatada com títulos, tópicos e blocos de código realçados, explicando o porquê o erro acontece e como aplicar o código. Veja um exemplo de estrutura:

# Correção do Erro responsiveVoice no Jogo do Número Secreto

Se o seu jogo parou de falar ou apresentou erro no console ao carregar a biblioteca do `responsiveVoice`, siga o passo a passo abaixo para corrigir.

### O que alterar no seu arquivo `app.js`:

2. Use o Gist para Embutir (Embed) no seu Blog ou Portfólio

Se você tiver um site pessoal, um artigo no LinkedIn ou uma publicação no Medium, você não precisa copiar e colar o código como texto puro. O GitHub fornece um script de incorporação para cada Gist.

Basta clicar no botão Embed (no canto superior direito do seu Gist), copiar a tag <script> gerada e colá-la no HTML do seu site. O código aparecerá lindo, com a formatação oficial do GitHub e com as cores corretas da linguagem de programação automaticamente!

Parabéns por desenvolver o espírito de colaboração open-source desde os primeiros passos com Git e GitHub. Compartilhar correções de problemas reais é o que faz a comunidade de tecnologia crescer forte!

Espero que possa ter lhe ajudado!