Construindo uma pré-visualização local

Existem dois scripts de shell disponíveis em cada repositório existente (incluindo o repositório de modelo usado para criar novo conteúdo): build.sh e preview.sh.

Para pré-visualizar, execute o script build.sh; este é o que realmente constrói uma versão local do site (ou, mais precisamente, o subconjunto do site completo que reside em seu repositório atual). Em seguida, execute preview.sh, que inicia um servidor web e serve o site no http://localhost:8080/. Abrir esta URL em qualquer navegador da web mostrará a pré-visualização, que estará disponível até você encerrar o processo (Ctrl+C no terminal).

Para executar os scripts, você precisará instalar Podman se estiver usando um sistema operacional Linux, tal como o Fedora, ou Docker CE se estiver usando o macOS.

Previewing multiple repositories

If your work spans content in multiple repositories, e.g. because you link to another repository, you can extend the preview by adding more repositories to site.yml as follows:

content:
  sources:
  - url: .
    branches: HEAD
  - url: https://pagure.io/fedora-docs/another-repository.git
    branches: main

Correct entries to use can be found from docs-fp-o site.yml.

Usando os scripts normais do Antora

Se você deseja usar o fluxo de trabalho regular de construção e pré-visualização do Antora, siga as instruções na Página de documentação do Antora.

Assim que você tiver Antora CLI e Antora Site Generator, você pode construir e pré-visualizar as páginas sem os scripts de contêiner.

Para construir as páginas no diretório do projeto, execute:

antora generate site.yml

Isso criará um novo diretório public que contém todos os arquivos necessários. Navegue até lá e execute um comando do servidor. Talvez você já tenha um servidor Python simples, nesse caso execute:

python3 -m http.server

ou se você só tiver Python 2 em sua máquina:

python -m SimpleHTTPServer

Isso abre uma pré-visualização local na porta 8000.

Se você tem cargo (o gerenciador de pacotes Rust), você também pode instalar e usar miniserve ou qualquer outro servidor simples de sua escolha para esse assunto.