Qual é a estrutura de um arquivo para publicar conteúdo no site?#

Os arquivos markdown nos quais se escreve o conteúdo para o Sitio possuem dois componentes principais:

Sítios construídos em Hugo não possuem uma base de dados para salvar os conteúdos nem programas para fazer a estrutura dos documentos, os conteúdos são salvos em arquivos e a estrutura do conteúdo é construída usando markdown e um cabeçalho que permite configurar metadados para cada documento.

Cabeçalho#

O cabeçalho é a primeira parte do documento e nesse Sitio é escrito em YAML , uma linguagem que ajuda a estruturar os documentos, por meio de inclusão de metadados.

No cabeçalho YAML podem ser incluídos, títulos, autoria, comentários ou etiquetas que ajudam a organizar conteúdo ou permitem fazer filtragem e buscas dos conteúdos dentro Sítio.

Um cabeçalho em YAML é um texto escrito em várias linhas na forma de chave: valor da seguinte maneira:

---
weight: 70
title: "Organização da Rede"
linkTitle: "Organização"
author: "Rede Ecovida"
date: 2023-08-20T12:05:39-03:00
lastmod: 2023-09-12T02:09:40-03:00
description: "Informações sobre a Rede Ecovida"
titleIcon: "fa-solid  fa-cogs"
categories: ["Sobre"]
tags: ["Manejo de conteúdo"]
toc: false
banner: true
bannerContent: "Página em elaboração"
draft: false
---
Note que no cabeçalho não deve haver espaços entre cada línea de texto e que para incluir uma nova variável é necessário iniciar escrita em uma nova linha. O cabeçalho pode desconfigurar se houverem desviações desse padrão ou se são retiradas algumas das linhas (---) que estão ao início e no final do mesmo

Variáveis utilizadas dentro do cabeçalho#

Algumas variáveis (ou chaves) utilizadas no cabeçalho YAML são:

  • weight
    • Se usa para organizar publicações dentro de uma sessão. Incluir um número menor organiza como primeira postagem dentro de uma sessão e páginas com número maior serão organizadas por último na barra lateral ou nos índices da sessão.
  • title
    • Título da página criada: aparece no início da página
  • linkTitle
    • Nome do título da página que aparecerá no índice de cada sessão e na barra lateral do Sitio
  • author
    • Nome da pessoa ou da organização responsável pela escrita do conteúdo
  • date
    • Data de escrita do documento. No exemplo se encontra no seguinte formato:
      • 2023-08-20T12:05:39-03:00 ([ano-mês-dia] Tempo: [hora:minuto:segundo-UTC ] )
      • Porém a data pode ser escrita em formatos curtos como 2023-08-20 ([ano-mês-dia])
O uso do formato ano-mês-dia facilita realizar organização dos dados dentro do sitio e filtrar documentos
  • description
    • Descrição do conteúdo da página
  • titleIcon
    • Ícone a ser incluído para a página. O ícone aparecerá na barra lateral do site e nos índices de cada sessão
  • categories
    • Uma categoria definida para o texto que é criado. As categorias podem ser usadas para filtrar conteúdos dentro do sitio.
  • tags
    • Uma ou várias etiquetas para identificar o texto que é criado. As etiquetas podem ser usadas para filtrar conteúdos dentro do sitio.
      • Para incluir várias etiquetas pode ser usada cada palavra o termo separado por vírgulas.
  • toc
    • Permite incluir (true) ou remover (false) uma tabela de conteúdo para o conteúdo da página.
  • banner
    • Permite incluir (true) ou remover (false) um banner com texto na parte superior da página.
  • bannerContent
    • Permite incluir o texto para o banner
  • draft
    • Permite incluir as páginas como rascunho (com valor de true: a página não é publicada) ou mudar para publicação no site (false)
Variável Uso Valores
weight Organizar postagens Número
title Incluir título Caracteres
linkTitle Incluir título em índice Caracteres
author Nome da pessoa/organização Caracteres
date Data, hora e UTC de elaboração Data e hora
lastmod Data, hora e UTC de modificação Data e hora
description Descrição de conteúdo Caracteres
tileIcon Incluir ícone Caracteres
categories Incluir categorias Caracteres
tags Incluir etiquetas Caracteres
toc Incluir tabela de conteúdo Booleano (true ou false)
banner Incluir banner Booleano (true ou false)
bannerContent Conteúdo do banner Caracteres
draft Incluir a página como rascunho Booleano (true ou false)
Quer saber mais sobre como criar postagens em Hugo? Visite o manual