Aula 04: Markdown para Programação 💻

Documentando Código como um Pró ⚙️

O que vamos aprender hoje? 🎯

1. Blocos de Código 📦
2. Destaque de Sintaxe ✨
3. Simulação de Terminal 🐚
4. Documentação de APIs 📡
5. Boas Práticas Técnicas 🌟

1. Blocos de Código e Sintaxe ⚙️

Código no Markdown pode ser de dois tipos.

Código Inline ⌨️

Para pequenas referências no meio do texto.

Exemplo: "A variável x recebe 10."

Sintaxe: Usamos crases simples `.

Blocos de Código (Fenced) 📦

Para grandes trechos de lógica.

Sintaxe: Três crases ``` no início e no fim.

2. Destaque de Sintaxe ✨

Não basta mostrar o código, ele tem que ser colorido!

Basta indicar a linguagem após as crases.

Exemplo Python 🐍

def hello():
    print("Markdown é top!")

Indicação: ```python

Exemplo Web 🌐

const app = () => {
    console.log("Olá Mundo!");
}

Indicação: ```javascript

3. Simulação de Terminal 🐚

Documentar comandos de instalação é vital.

O termynal torna isso interativo!

Exemplo de Terminal 🐚

$ cd projeto
$ npm install
$ npm run dev

Mostra a jornada do dev passo a passo.

4. Documentação de APIs 📡

Markdown é a base para documentar REST APIs.

Use Tabelas + Blocos JSON.

Exemplo de Endpoint 📍

POST /v1/login

Retorno em JSON 📦

{
  "status": "success",
  "token": "ey123..."
}

Fluxo de Trabalho (Mermaid) 🧜‍♀️

mermaid graph LR A[Código Bruto] --> B(Markdown Parser) B --> C{Tem Linguagem?} C -->|Sim| D[Realce de Cores] C -->|Não| E[Texto Plano]

5. Boas Práticas Técnicas 🌟

• Comentários: Inclua comentários no código.
• Acessibilidade: Explique o que o código faz antes do bloco.
• Versão: Indique para qual versão da linguagem o código serve.

Praticando no Terminal 🐚

$ echo "print('Ola')" > manual.md
$ cat manual.md

Exercício Rápido 🧠

Como indicar realce para a linguagem "Go"?

A) ```go ✅ B) #language: go C) (go)

Mini-Projeto 🎨

Crie o documentacao.md.

• Nome da Função (H2)
• Bloco de Código (Syntax Highlight)
• Tabela de Parâmetros
• Simulação de Execução (Termynal)

Resumo da Aula 📝

• Crase simples para inline.
• Crase tripla para blocos.
• Nomes de linguagens para cores.
• Tabelas para organizar APIs.

Fim do Módulo 1! 🏆

Você já domina os fundamentos!

Na próxima aula (Módulo 2)...

Aula 05 - Tabelas e Estrutura Técnica 📊

Obrigado! 🙏

"Documentar é um ato de amor ao seu 'eu' do futuro."

Ver Aula 05