Nomes de diretórios e arquivos

Algumas dicas para simplificar a construção do site, a criação de links no Site e para facilitar realizar referências de páginas do Site dentro dos textos são:

1. Usar sempre nomes "sintáticos" para diretórios e arquivos​

Ou seja, evitar o uso de espaços e caracteres especiais nos nomes de arquivos e diretórios, para evitar quebrar os links.

Exemplo: no seguinte nome de diretório, existe um espaço:

docs/Projetos/Pecuaria Floresta/

Ao deixarmos o espaço podemos ter problemas ao editar o construir o site, ou pode acontecer do link no site em produção fique com espaço, o que entendo não é recomendável

Podemos usar então, sempre que possível, nomes curtos para diretórios (uma palavra, se possível) e caso precisar mais palavras, incluir underline

Exemplo: Pecuaria_Floresta

Opa!

O uso de caracteres especiais cria potenciais problemas de leitura. Por exemplo, o uso de acentos ou cedilha pode criar links como:

Exemplo de uso de caracteres especiais em nomes de arquivos
docs/Projetos/Pecuaria Floresta/2025/04_Fotos - Implanta\303\247\303\243o e Acompanhamento`

Os caracteres \303\247\303\243 estão representando as letras çã

Podemos padronizar para evitar uso de cedilha e acentos e substituir por caracteres "similares"

Por exemplo, ao invés de escrever "Implantação", usar "Implantacao", ou mesmo sinônimos

Se usarmos essa opção, podemos controlar qual nome será dado ao link no site. Assim por exemplo:

Se com espaço o link seria para a página de apresentação da seção (index.md):

https://site.multifarm.top/docs/Projetos/Pecuaria Floresta/

dica
Usando a opção slug no cabeçalho:
---
title: Projeto Pecuária Floresta
date: 2026-01-01
sidebar_label: Pecuária Floresta
slug: apresentacao
last_update:
  date: '2026-03-20'
  author: 'Ana Laura Carrilli'
---

O link ficaria:

https://site.multifarm.top/docs/Projetos/Pecuaria_Floresta/apresentacao

Podemos usar essa opção, se for necessário, para criar os links, seguindo lógica similar ao nome de diretório: usando palavras curtas e se necessário usar underline para separar palavras.

dica

Para criar referências documentos criados no site a outros documentos é apropriado lembrar que se é usada a opção slug, o link para referenciar deve contemplar essa opção.

Ou seja, o link não será mais o nome do arquivo, senão aquele que seja definido usando a opção "slug"

3. Ao construir nomes de arquivos é importante considerar​

  • Os nomes no sistema de arquivos são feitos para as máquinas lerem, além de permitirem que quem cria a documentação se localize nos arquivos, mas quanto mais simples, curtos e intuitivos os nomes, pode ser mais simples a navegação, então o foco na escrita sintática deve sempre ser uma consideração
  • Os nomes que aparecem para as pessoas que visitam o site podem ser configurados nos textos e nos cabeçalhos, então o foco na escrita com estilo deve estar focada nessa parte dos documentos

4. Resumindo​

Resumo
Sugestão de padronização de nomes de diretórios ("pastas") e arquivos
  • Usar nomes em minúsculo tanto para diretórios como para arquivos (exemplo: proj ao invés de Proj)
  • Evitar uso de caracteres especiais (*, ç) e acentos (~, ^, ´)
  • Reduzir a extensão dos nomes, sempre que possível (Organizacao_Produtiva pode virar prod, por exemplo)
  • Evitar o uso de espaços nos nomes. Use traço (-) ou underline (_) ao invés do espaço
  • Utilizar o nome index.md para documentos que são o índice do diretório (documento de "apresentação")
  • Incluir data em formato ISO ao início (principalmente de publicações no Blog)
    • Exemplo: 2026-02-27-sistema-silvipastoril.md
  • Usar opção slug no cabeçalho do documento para indicar como construir o link no site em produção, sempre que achar necessário
Última atualização em por Equipe