Title

Introdução

Este template serve para orientar a documentação de programas e códigos. A linguagem utilizada é o Markdown e com ela é possível criar textos referenciados com hyperlinks e de fácil transposição para consoles e IDEs de programação.

Implementação

Um link pode ser referenciado no decorrer do texto, mas, deve-se observar e repetir a URL nas referências finais.
Um link para o site VHTEL pode ser inserido tanto próximo ao texto quanto ao final, em uma seção específica.

  1. Quanto à documentação de códigos, o BLOCO DE CÓDIGOS é indicado para sequências de códigos e saídas da console. Ele exibe dintintas cores para os conteúdos, de acordo com o tipo do parâmetro e linguagem definida após os 3 ` ` ` (backticks).
1
2
3
4
5
6
7
8
9
10
11
$ ping -c 4 www.google.com
PING www.google.com (172.217.28.4) 56(84) bytes of data.
64 bytes from eze03s15-in-f4.1e100.net (172.217.28.4): icmp_seq=1 ttl=114 time=15.2 ms
64 bytes from eze03s15-in-f4.1e100.net (172.217.28.4): icmp_seq=2 ttl=114 time=15.4 ms
64 bytes from eze03s15-in-f4.1e100.net (172.217.28.4): icmp_seq=3 ttl=114 time=15.7 ms
64 bytes from eze03s15-in-f4.1e100.net (172.217.28.4): icmp_seq=4 ttl=114 time=15.9 ms

--- www.google.com ping statistics ---
4 packets transmitted, 4 received, 0% packet loss, time 8ms
rtt min/avg/max/mdev = 15.223/15.582/15.937/0.274 ms

  1. Tembém é possível utilizar recurso similar para criar uma caixa de destaque ou para destacar apenas um comando.
1
2
3
$ date
qui jan 14 23:16:54 -03 2021

  1. Comando em destaque: date

Lista de comandos utilizados

1
2
3
ping
date

Referências