Este documento unifica as diretrizes de formatação de conteúdo (Markdown) e de taxonomia/URLs (slugs) para a base de conhecimento. O objetivo é garantir consistência visual, organização lógica, facilidade de navegação e qualidade técnica dos conteúdos.
No Wiki.js, a URL de uma página é determinada pela sua posição na árvore.
linux, docker), sempre em singular (linux, não linuxs).linux/bash).
/linux/bash) deve conter um índice ou introdução; nunca deixe apenas como contêiner vazio.linux/bash/gerar-senha).
Se você versiona o conteúdo do Wiki.js em Git (prática recomendada), os arquivos .md devem espelhar os slugs das páginas:
| Página no Wiki | Nome do arquivo |
|---|---|
/linux/bash/gerar-senha |
linux-bash-gerar-senha.md |
/docker/instalacao-ubuntu |
docker-instalacao-ubuntu.md |
Regras:
.md (Markdown)_v2, _final, _revisado)a-z).0-9) são permitidos quando fizerem parte do nome técnico (ex: python-3).-)._, acentos (ã, é), cedilha (ç), símbolos (!, @, #, etc.).a, o, de, para, com).docker/guia-comandosdocker/o-guia-de-todos-os-comandos/nginx/instalacao./python/migracao-v2-para-v3.| Título da Página | Slug automático (evite) | Slug ideal (use) | Motivo |
|---|---|---|---|
| Instalação do Docker no Ubuntu 22.04 | instalacao-do-docker-no-ubuntu-22-04 |
docker/instalacao-ubuntu |
Remove conectores e foca no essencial. |
| Como configurar o VIM para Python? | como-configurar-o-vim-para-python |
vim/configurar-python |
Estrutura hierárquica e direta. |
| Script de Backup de Banco de Dados | script-de-backup-de-banco-de-dados |
db/script-backup |
Curto e categorizado. |
/linux/bash/gerar-senha)./linux/bash/gerar-senha pode ter #seguranca, #autenticacao, #script.Para evitar dispersão terminológica (ex: #seguranca vs #security vs #segurança), adote este vocabulário padronizado:
#linux #docker #kubernetes #k8s #terraform #ansible #rede #firewall #dns #storage #backup #monitoramento
#guia #tutorial #referencia-rapida #troubleshooting #script #checklist #comparativo #arquitetura
#basico #intermediario #avancado #especialista
#rascunho #em-revisao #aprovado #atualizado #depreciado #obsoleto
#homologacao #producao #ha #dr #performance #seguranca #compliance
Regra importante: sempre use o vocabulário em português (sem acentos) e minúsculas, a menos que o termo seja um nome próprio de produto (ex: #GitLab, #OpenSearch).
# Título nível 1
## Título nível 2
### Título nível 3
#### Título nível 4
Use no máximo até nível 3 na maioria dos casos; nível 4 apenas quando realmente necessário.
**negrito**
*itálico*
~~texto riscado~~
`código inline`
- Item 1
- Item 2
- Item 3
1. Primeiro item
2. Segundo item
3. Terceiro item
[Texto do link](https://exemplo.com)
[Guia de Bash](/linux/bash/guia-introducao)
[Guia Bash](https://wiki.sefaz.rn.gov.br/linux/bash/...) (só use para acesso externo)../../linux/bash (quebra facilmente)Use âncoras baseadas no título:
[Volte para Pré-requisitos](#pré-requisitos)
https:// (nunca http://)```bash
sudo systemctl restart nginx
```
Troque bash pela linguagem apropriada (sh, yaml, json, python, hcl, go, sql, etc.).
Boas práticas para blocos de código:
$ ou #) a menos que seja necessário demonstrar contexto de usuário vs root\| Coluna A | Coluna B |
|----------|----------|
| Linha 1A | Linha 1B |
| Linha 2A | Linha 2B |
- [ ] Tarefa pendente
- [x] Tarefa concluída
| Tipo de imagem | Formato | Motivo |
|---|---|---|
| Diagramas, esquemas, prints de terminal | PNG | Qualidade lossless, texto nítido |
| Fotografias, screenshots complexos | WebP | Compressão superior, menor tamanho |
| Ícones, logos | SVG | Escalável, tamanho mínimo |
| Evitar | BMP, TIFF | Tamanho excessivo |
diagrama-arquitetura-k8s.png, configuracao-firewall-nftables.pngIMG_20240415.jpg, screenshot1.png, imagem.pngfluxo-git-1200x800.pngalt text descritivo: /assets ou /imagens na raizUse blockquote (>) com classes para criar blocos visuais.
> Esta é uma nota informativa para o leitor.
{.is-info}
> Dica: execute este comando primeiro em ambiente de teste.
{.is-success}
> Atenção: esta ação não pode ser desfeita.
{.is-warning}
> Perigo: não execute este procedimento em produção sem backup.
{.is-danger}
Listas dentro de destaques:
> - Passo 1 da dica
> - Passo 2 da dica
<!-- {blockquote:.is-info} -->
Use quando a página representa uma categoria/subcategoria (/linux, /docker, /linux/bash).
---
title: *Nome da Categoria*
description: *Breve descrição da categoria para SEO (máx. 160 caracteres)*
tags:
- *categoria*
- *indice*
---
# *Nome da Categoria*
*Breve descrição da categoria (1 a 2 frases). Ex: Guias e referências sobre administração Linux.*
---
## Índice de Conteúdo
*Navegue pelos tópicos disponíveis nesta seção:*
### *Subcategoria ou Tema 1*
- **[Título da Página 1](/caminho/para/pagina1)** – `#tag1 #tag2` – *Descrição sucinta do que a página aborda.*
- **[Título da Página 2](/caminho/para/pagina2)** – `#tag3 #tag4` – *Descrição sucinta.*
### *Subcategoria ou Tema 2*
- **[Título da Página 3](/caminho/para/pagina3)** – `#tag5 #tag6` – *Descrição sucinta.*
---
## Como Contribuir
*Opcional: instruções para quem deseja adicionar ou editar conteúdo nesta categoria.*
> Siga as diretrizes de Taxonomia e URLs desta página ao criar novas páginas.
{.is-info}
---
**Tags sugeridas para esta página:** `#categoria` `#*nome-da-categoria*` `#indice`
Use para guias, tutoriais e how‑tos (/linux/bash/gerar-senha, /docker/guia-comandos).
---
title: *Título da Página*
description: *Resumo curto (máx. 160 caracteres) para SEO e visualização em listas.*
tags:
- *tag1*
- *tag2*
- *tag3*
---
# *Título Principal*
*Introdução ao tema. Explique o que será abordado, para quem é este guia e qual problema ele resolve. (2 a 3 parágrafos curtos).*
---
## Pré‑requisitos
- *Item 1 (ex: conhecimento básico de terminal)*
- *Item 2 (ex: ter o `openssl` instalado)*
- *Item 3 (ex: sistema Linux)*
---
## Passo a Passo / Explicação
### 1. *Primeiro passo / conceito*
*Explique o primeiro passo, comando ou conceito. Use blocos de código quando necessário.*
```bash
# exemplo de comando
comando --opcao argumento
```
### 2. *Segundo passo / conceito*
*Descrição detalhada. Inclua imagens, diagramas ou alertas se relevante.*
> **Atenção:** *Destaque pontos importantes ou erros comuns.*
{.is-warning}
---
## Exemplos Práticos
*Apresente exemplos completos de uso, com saída esperada ou casos comuns.*
```bash
# Exemplo 1
comando --exemplo1
```
```bash
# Exemplo 2
comando --exemplo2
```
---
## Script Completo (se aplicável)
<details>
<summary>
<strong>Script completo: *nome-do-script* (clique para expandir)</strong>
<br>
<em>(~*número* linhas)</em>
</summary>
```bash
#!/usr/bin/env bash
# Coloque aqui o script completo...
```
</details>
---
## Troubleshooting / Problemas Comuns
| Sintoma | Causa provável | Solução |
|---------|---------------|---------|
| *Erro X* | *Causa Y* | *Como resolver* |
---
## Referências
- [Título do link 1](url) – *Breve descrição*
- [Título do link 2](url) – *Breve descrição*
- [Documentação oficial](url)
---
## Histórico de Alterações
| Data | Versão | Autor | Descrição |
|------------|--------|--------------|--------------------------------------|
| 2026-04-15 | 1.0.0 | @gean | Criação inicial do guia |
| 2026-04-20 | 1.1.0 | @douglas | Adicionada seção de troubleshooting |
| 2026-05-10 | 1.1.1 | @ana | Correção de comandos obsoletos |
---
**Tags:** `#guia` `#tutorial` `#*linux*` `#*bash*` *(adicione outras tags relevantes)*
_)?/linux/...)?alt text descritivo?Ao demonstrar código Markdown dentro de uma página (como neste guia), é preciso impedir que o próprio Wiki.js interprete o bloco de exemplo.
Quando você quiser mostrar um exemplo de bloco de código que também usa crases triplas, use quatro crases para abrir e fechar o bloco externo:
```bash
echo "Exemplo de comando"
```
No resultado, o conteúdo entre ```bash ... ``` será exibido como exemplo, sem ser interpretado como bloco "real" pelo Wiki.js.
text, garantindo que nada seja interpretado como sintaxe especial.Documento versionado conforme semântica de versionamento (MAJOR.MINOR.PATCH).
Última atualização: 2026-04-15