Olá a todos,
Eis como escrevo artigos técnicos, para o tornar legível, e útil para o futuro, eu próprio que quero lembrar-me de como usar esse material técnico sobre o qual escrevi um artigo há vários meses.
O que está a ler é a introdução. Começo pela introdução, porque o meu tema toma esse texto como resumo na primeira página.
Aqui está o meu ficheiro post.md começando :
*my archetype*
--
Hoje quero falar sobre os arquétipos do motor de geração do sítio Hugo. Este motor muito potente é utilizado para gerar estas páginas.
<!--truncate-->
Algum tema compreende o "mais balise", pelo que a minha introdução termina com ele.
Posso terminar a minha introdução depois da <!--truncate--> se eu achar que é demasiado longo, ou outra coisa qualquer.
Títulos
Continuo o post usando o título. Penso que o título é importante, porque nos permite compreender a estrutura do artigo, e permite aos "utilizadores de poder" ir directamente para a parte que eles excepto para encontrar informações.
No meu artigo anterior, sobre arquétipos, os meus títulos eram :
## archetypes/Default.md
(...)
## archetypes/mon_mien.md
(...)
Poderia ter usado uma estrutura mais complexa, utilizando títulos de segundo ou terceiro nível
# First level
## Second level
### Third level
Esse código será exibido assim no blogue :
Primeiro nível
blablabla
Segundo nível
blablabla explicado
Terceiro nível
blablabla mais especificado
É importante colocar Título no seu tutos. Por vezes, os leitores liam mais do que um tuto ao mesmo tempo, e é mais fácil ir para a parte seguinte quando o título organizava a página.
Exibição do código
Há dois tipos de forma de colocar o código no markdown :
código em linha
Isto é quando se usa ``` 'my code is cool' ``` na mesma linha que o resto do texto
código de linha única isolado
Isto é quando se utiliza :
```
my code is cool
```
O código é isolado do resto do parágrafo
O meu conselho
Utilizar sempre o segundo. Por uma razão simples : as pessoas utilizam copiar/colar. E é tão mais fácil copiar colar uma única linha.
Próximas dicas
Balas
- Não
- utilização
- bala
- em todo o lado
Faça-o quando for útill. Há dois casos :
- lista de coisas
- lista de coisas
Usar citação para citação
Usar citação para citação. Sei que parece estranho, mas poderia querer usar o bom formato de citação para outra coisa. Não o faça.
Estilo de citação é para citação - Dr. CssProvider