Por que Markdown
Markdown e o padrao de facto para documentacao tecnica: e texto puro, versionavel no Git, legivel em qualquer editor e independente de plataforma. Com o front-matter, os metadados do artigo viajam junto do conteudo em um unico arquivo.
Metadados (front-matter)
O bloco entre --- no topo do arquivo define os metadados aceitos pelo CMS. As chaves sao as mesmas do formato TXT legado:
| Campo | Obrigatorio | Descricao |
|---|---|---|
titulo | Sim | Nome do artigo e slug da URL |
resumo | Nao | Texto curto para cards e SEO |
categoria | Nao | Trilha editorial (ex.: Backend) |
autor | Nao | Nome do autor ou equipe |
data | Nao | Data de publicacao (YYYY-MM-DD) |
tempo | Nao | Tempo estimado de leitura |
icone | Nao | Classe do Bootstrap Icons |
cor | Nao | blue, green, purple ou orange |
Sintaxe disponivel
O corpo do artigo usa Markdown padrao, sempre convertido para HTML seguro por um parser proprio (todo texto e escapado antes da conversao).
Formatacao inline
E possivel usar negrito, italico, tachado e codigo inline. Links externos como <https://www.php.net> recebem rel="noopener" automaticamente, e URLs inseguras sao neutralizadas.
Citacoes
APIs duraveis sao simples de consumir, explicitas nos erros e honestas sobre seus limites.
Blocos de codigo
$artigo = load_article('apis-escalaveis');
echo $artigo['meta']['titulo'];Listas
- Contratos antes de implementacao
- Erros padronizados e previsiveis
- Observabilidade desde o primeiro deploy
Lista ordenada tambem funciona:
- Escreva o
.mdcom front-matter - Adicione o arquivo em
content/articles - O artigo aparece na home automaticamente
Tabelas
Tabelas viram <table> Bootstrap responsiva:
| Formato | Extensao | Status |
|---|---|---|
| Markdown | .md | Recomendado |
| TXT com tags | .txt | Legado, ainda suportado |
Compatibilidade
O formato TXT com tags (<paragrafo>, <subtitulo>, ...) continua funcionando sem alteracao. O parser detecta o formato pelo front-matter ou pela extensao do arquivo, e .md tem prioridade quando os dois existem com o mesmo slug.
content/articles.