A documentação da API em Markdown: Ver em Markdown, Copiar página e para que servem

IA e Agentes·· 30 visualizações· 3 min de leitura

A resposta curta: todas as páginas da documentação existem também em Markdown, texto simples com marcação leve. No topo de cada página há dois botões: Ver em Markdown abre essa versão e Copiar página copia-a de uma vez. Servem sobretudo para dar a documentação a um assistente de IA ou para a guardar junto do seu código.

Os dois botões

Botão O que faz
Ver em Markdown Abre a página em Markdown, num endereço próprio que termina em .md. Por exemplo, Começar com a API em Markdown.
Copiar página Copia esse mesmo texto para a área de transferência, pronto a colar noutro sítio.

Para que serve

1 Dar contexto a um assistente de IA: cole a página numa conversa e peça código, uma explicação ou uma revisão. O assistente fica a trabalhar com o texto certo, e não com o que se lembra.
2 Guardar junto do código: uma cópia da página da área que usa, dentro do projecto, ajuda quem vier depois de si.
3 Ler fora do navegador: num editor de texto ou no terminal, sem menus nem botões.
4 Ver o que mudou: cada versão traz a data de actualização no topo; guardando cópias, compara uma com a outra.

O que muda em relação à página

Na versão Markdown Como fica
Topo O título, a frase de descrição e a data «Actualizado em».
Texto O mesmo da página, sem menus, botões nem Playground.
Ligações Endereços completos, que levam às versões Markdown das outras páginas.
Páginas das áreas A explicação e, a seguir, todas as operações, com os exemplos nas quatro linguagens e as respostas.
Referência Uma tabela por área, com o método, o caminho e o que cada operação faz.
As versões Markdown não aparecem nos motores de pesquisa. Para enviar a alguém uma ligação para ler, use a página normal; o Markdown é para colar e para ferramentas.
Quer a lista de todas as páginas Markdown de uma vez? Está no ficheiro llms.txt da documentação: veja o llms.txt e as ferramentas de IA.

Experimente com a página que mais usa: abra-a e carregue em Ver em Markdown.

Abrir a documentação

VEJA TAMBÉM

A documentação da API e a IA: o ficheiro llms.txt e dar a documentação inteira a um assistente

Resumir com IA e Partilhar na documentação da API: o que fazem e quando confiar na resposta

Entregar a documentação da API a um programador: ligações a secções, Markdown e a especificação

Como está organizada a documentação da API: Começar, Áreas, Referência e Playground

llms.txt: o que é e se faz alguma coisa pelo seu site

PRODUTO RECOMENDADO

Hospedagem de sites com cPanel

Domínio e SSL incluídos, cópias diárias e o painel que já conhece. desde 396,00 MT/mês (plano de 3 anos, com cupão)

Ver planos
Esta resposta foi útil? A sua resposta ajuda-nos a melhorar este artigo.