Aula 04 - Markdown para Programação 💻

Objetivo

Objetivo: Aprender a utilizar blocos de código, aplicar destaque de sintaxe para diferentes linguagens, documentar APIs e utilizar o Termynal para simulações de linha de comando.

1. Blocos de Código e Sintaxe ⚙️

Existem duas formas de representar código:

Código Inline: Use crases simples ` para pequenos trechos (ex: variable_name).
Blocos de Código: Use cercas de crase (fenced code blocks) com três crases ```.

Destaque de Sintaxe (Syntax Highlighting)

Indique a linguagem após as primeiras crases para que o Markdown aplique cores automáticas.

def saudacao():
    print("Olá, Mundo!")

const soma = (a, b) => a + b;

2. Documentação de APIs 📡

Markdown é perfeito para descrever endpoints e contratos de dados.

Exemplo de Documentação de Endpoint:

GET /usuarios Retorna a lista de usuários cadastrados.

Campo	Tipo	Descrição
`id`	Integer	ID único do usuário
`nome`	String	Nome completo

3. Simulação de Terminal (TermynalJS) 🐚

Em documentações técnicas, mostrar a saída do terminal ajuda muito o desenvolvedor.

$ npm install markdown-it
$ mkdir docs
$ ls -l
total 0
drwxr-xr-x 1 user staff 0 Feb 19 23:30 docs

4. Diferenciando Saída e Entrada 📊

Ao documentar, deixe claro o que é o comando e o que é a resposta do sistema.

# Comando do usuário
git status

# Saída do sistema
On branch main
nothing to commit, working tree clean

5. Fluxo de Desenvolvimento (Mermaid) 🧜‍♀️

```mermaid sequenceDiagram participant Dev as Desenvolvedor participant Doc as Documentaçao .md participant Server as Servidor MkDocs

Dev->>Doc: Escreve código no bloco
Doc->>Server: Processa Destaque de Sintaxe
Server-->>Dev: Exibe código colorido no site

```

6. Mini-Projeto: Documentando um Código 🏗️

Escolha um pequeno trecho de código em qualquer linguagem que você conheça e documente-o: 1. Use um título H2 com o nome da função. 2. Adicione um parágrafo explicando o que o código faz. 3. Insira o código em um bloco com o destaque de sintaxe correto. 4. Crie uma pequena tabela descrevendo os parâmetros de entrada e o retorno.

7. Exercícios de Fixação 🧠

Qual a diferença entre código inline e blocos de código?
Como indicar ao Markdown que o código escrito é em linguagem Go?
Por que documentar o retorno (output) do terminal é importante em um tutorial técnico?

Próxima Aula: Vamos iniciar o Módulo 2 com Tabelas e Estrutura Técnica! 📊