Skip to main content

Como usar Markdown (CommonMark) na nossa wiki

Nota: Este documento é uma tradução automática da versão original em inglês.

Esta página é um pequeno "guia rápido" para formatar páginas em nossa wiki, onde o conteúdo é escrito em CommonMark Markdown.

Regras básicas

  • Escreva em frases simples e curtas.
  • Torne a página fácil de escanear (leitura dinâmica): títulos + listas + tabelas.
  • Uma seção = uma ideia. Evite "paredes de texto".

Títulos

Use ## / ### / #### para estrutura.

## Seção
### Subseção
#### Sub-subseção

Negrito, itálico, código embutido

**negrito**
*itálico*
`código/campo/endereço`

[texto do link](https://example.com)

Se você precisar mostrar um link "bruto" (raro):

`https://example.com`

Listas

Lista com marcadores:

- item 1
- item 2
  - subitem

Lista numerada:

1. passo 1
2. passo 2
3. passo 3

Citações / notas

> Esta é uma nota importante.
> Pode ter duas linhas.

Tabelas

Modelo mínimo:

| Campo | Valor |
|---|---|
| Nome | [ ] |
| Status | [ ] |

Dicas:

  • A linha de separação |---|---| é obrigatória.
  • As células da tabela podem conter **negrito**, links e código.

Blocos de código e texto "bruto"

Bloco de código:

\```text
linha 1
linha 2
\```

Se for uma linguagem específica (por exemplo, JSON), você pode especificá-la:

\```json
{ "chave": "valor" }
\```

Imagens

Se você tiver um URL direto da imagem:

![descrição](https://example.com/imagem.png)

Se o arquivo for carregado na wiki, use o link/incorporação que a wiki fornece no momento do upload.

Quebras de linha e parágrafos

  • Um novo parágrafo é uma linha em branco entre parágrafos.
  • Se você precisar de uma quebra de linha dentro de um parágrafo, adicione dois espaços no final da linha:
Primeira linha.  
Segunda linha.

HTML incorporado (use com cuidado)

Bloco "Detalhes" expansível

Use-o para detalhes/evidências longas para evitar sobrecarregar a "primeira tela".

<details>
<summary><b>Detalhes</b></summary>

Você pode colocar texto, listas e tabelas aqui.

</details>

Âncora:

<a id="ai-thesis-fit"></a>

[Ir para adequação da tese de IA](#ai-thesis-fit)

Espaços reservados em modelos

Nos modelos usamos:

  • [ ] — "preencher"
  • — / — — "— / não aplicável" (quando fizer sentido)
  • YYYY‑MM‑DD — formato de data
  • Tier‑1/2/3 — nível da fonte (evidência/contexto/ruído)

Erros comuns

  • Misturar caixa de informações (infobox) e descrição: a caixa de informações é apenas para fatos curtos; as explicações vão no corpo da página.
  • Escrever sem fontes onde deveria existir uma fonte.
  • Sobrecarregar a "primeira tela": detalhes longos são melhor colocados dentro de <details>.
  • Usar "linguagem financeira" (conselhos de compra/venda/manutenção, previsões) — é proibido para nós; escrevemos fatos/riscos/o que verificar.

Mini lista de verificação antes de publicar

  • Existem 1-2 linhas que explicam "o que é"?
  • Existem links para fontes primárias?
  • Existem campos de tabela vazios "pouco claros" (cada um deve ser um valor ou —/—)?
  • Last verified (Última verificação) está preenchido?

No comments to display

Back to top