Visão Geral da Arquitetura

O ecossistema do Apache Royale utiliza o Pelican, um gerador de sites estáticos robusto escrito em Python, para criar e manter sua documentação e páginas institucionais. Esta abordagem fornece uma base padronizada e altamente personalizável, garantindo conformidade com as diretrizes de infraestrutura de projetos da Apache Software Foundation.

Configuração do Ambiente de Desenvolvimento

Para iniciar o desenvolvimento local, é necessário configurar o ambiente Python e instalar as dependências do gerador estático.

Enstalação das Dependências

Recomenda-se o uso de um ambiente virtual. Execute o comando abaixo para instalar o núcleo do Pelican junto com o suporte a Markdown:

python -m pip install "pelican[markdown]"

Obtenção do Código-Fonte

Clone o repositório oficial e navegue até o diretório raiz do projeto:

git clone https://github.com/apache/royale-pelican-website.git royale-docs
cd royale-docs

Compilação e Visulaização

O processo de geração dos arquivos HTML, CSS e JavaScript é controlado pelo arquivo de configuração principle.

Ajustes de Configuração

Abra o arquivo pelicanconf.py e atualize as variáveis de ambiente, como SITENAME, SITEURL e AUTHOR, para refletir as propriedades do seu projeto específico.

Geração dos Artefatos Estáticos

Para compilar o conteúdo da pasta content e exportar os arquivos resultantes para o diretório de saída, utilize o seguinte comando:

pelican content -s pelicanconf.py -o public_html

Servidor de Desenvolvimento Local

Para validar as alterações em tempo real com recarregamento automático, inicie o servidor web embutido:

pelican --listen --autoreload --port 8080

Acesse http://localhost:8080 no seu navegador para inspecionar a interface renderizada.

Integração com o Ecossistema Royale

Embora este repositório atue estritamente como uma ferramenta de infraestrutura para publicação de conteúdo, ele complementa o ciclo de vida do Apache Royale. O framework Royale em si é focado na criação de aplicações ricas para web e desktop utilizando uma sintaxe baseada em ActionScript e MXML, que é transpilada para JavaScript otimizado através do Royale Compiler. A documentação gerada por este template serve como ponto de entrada para desenvolvedores que exploram as bibliotecas de componentes UI e as integrações de framework disponíveis na organização oficial do projeto.