Tutorial - Instalação e configuração de Cecil, um gerador de sites estáticos (SSG) em PHP

Objetivo

Este tutorial explica-lhe como instalar e configurar Cecil. Trata-se de uma aplicação escrita em PHP que permite gerar e administrar páginas web estáticas.

Um website composto essencialmente por páginas web estáticas garante um melhor tempo de carregamento para os seus visitantes e uma maior segurança. Sem conteúdo dinâmico, as suas páginas são mais robustas face aos ataques informáticos. A geração de um website estático permite dispor de uma maior liberdade para criar um website à sua escolha. Também ganhará tempo, pois não terá a partir do zero.

Descubra como Cecil lhe permite criar o seu site estático com a ajuda de um motor de template moderno (Jamstack).

Requisitos

• Ter um plano de alojamento web da OVHcloud que inclui um acesso SSH. Este acesso permite instalar em linha de comandos uma ou várias soluções alternativas às que são propostas por predefinição nas nossas ofertas de alojamento web.
• estar familiarizado com a introdução em linha de comandos.
• Ter capacidade para transferir ficheiros em FTP com um cliente como FileZilla.
• Configurar a sua zona DNS para apontar o seu nome de domínio (ou subdomínio) para o seu alojamento web partilhado. Isto revela-se particularmente útil se pretender alojar vários sítios web no seu alojamento web partilhado.
• Instalar previamente Composer com o ficheiro composer.phar na raiz do seu alojamento web partilhado ou na pasta alvo do seu domínio.

Instruções

Um alojamento web partilhado permite declarar domínios ou subdomínios nos sítios web que contém. Um domínio ou subdomínio é necessário para implementar o seu sítio web criado com Cecil.

Para o ajudar a declarar um domínio ou subdomínio num dos sítios web do seu alojamento, consulte a nossa página « Partilhar o seu alojamento entre vários sítios ».

Criar o diretório no qual serão os seus ficheiros

Depois de aceder ao seu alojamento web através de SSH, crie um diretório root com o seguinte comando:

mkdir mystaticwebsite

Substitua mystaticwebsite pelo nome de pasta que escolheu (sem acentos e sem espaços).

De seguida, aceda a este diretório:

cd mystaticwebsite

Substitua mystaticwebsite pelo seu nome de pasta.

Descarregamento

No diretório que acaba de criar, descarregue Cecil:

curl -OL https://github.com/Cecilapp/Cecil/releases/latest/download/cecil.phar

Instalação

Execute a instalação de Cecil com o seguinte comando:

php cecil.phar new:site

Introduza os elementos solicitados:

• o título do seu site _ (title)_
• baseline
• o URL do seu website (por exemplo, https://mywebsite.ovh)
• uma descrição do seu website

Depois de inserir estes elementos, deverá implementar o website utilizando o seguinte comando:

php cecil.phar build

Ao visualizar o conteúdo do diretório, verificará a presença de um diretório _site. Este diretório deve conter todos os ficheiros HTML e bases de dados:

Agora pode ver o resultado ao aceder ao seu domínio:

Configuração do apontamento do domínio ou subdomínio

Para visualizar o resultado do seu website no seu browser, modifique o apontamento do seu nome de domínio ou de subdomínio no diretório _site criado anteriormente aquando da instalação de Cecil.

Se o seu nome de domínio ou subdomínio estiver alojado na OVHcloud, consulte os nossos guias relativos à configuração DNS e à implementação de um sítio web no seu alojamento web.

Configurar o seu site

As informações gerais do seu site podem ser configuradas no ficheiro config.yml:

nano config.yml

Substitua as informações predefinidas pelos seus e guarde o ficheiro.

Criar uma nova página

A criação das páginas que conterão os dados do seu site faz-se através de ficheiros no formato Markdown. Estas páginas são personalizáveis. Cecil integra o motor de template Twig que é utilizado de forma padrão com framework Symfony.

Os ficheiros e ficheiros são organizados da seguinte forma:

• assets: contém elementos gráficos, áudio e vídeo, scripts JavaScript e estilos (CSS, Sass)
• layouts: diretório no qual serão o ou os templates
• pages local onde serão os seus ficheiros Markdown
• _site diretório que contém os ficheiros gerados e que é apontado pelo seu nome de domínio
• static: todos os ficheiros estáticos do tipo PDF

Criar um ficheiro Markdown em linha de comandos

Na raiz do website, introduza o seguinte comando:

php cecil.phar new:page mypage.md

Um ficheiro mypage.md é criado na raiz do diretório /pages.

Substitua mypage por um nome próprio.

Gerar os ficheiros estáticos

Na raiz, introduza o seguinte comando:

php cecil.phar build

O seu ficheiro encontra-se no diretório _site/mypage/:

Pode visualizá-lo no seu servidor introduzindo o URL do seu site, seguido de /mypage/:

Personalizar os ficheiros do seu site

Modificação no servidor

A edição dos ficheiros Markdown pode ser feita diretamente no servidor de alojamento web. Na sua oferta de alojamento Performance, o seu acesso SSH permite utilizar indiferentemente GNU nano, vi ou vim. As capturas de ecrã do presente tutorial foram realizadas sob GNU nano.

Editar o ficheiro mypage.md situado no diretório pages o seguinte comando se estiver na raiz do seu site:

 nano pages/mypage.md

Substitua mypage por um nome próprio.

Adicione algumas linhas respeitando a syntaxe Markdown:

Elimine os ficheiros na cache através do seguinte comando:

php cecil.phar clear

Reconstrua as suas páginas após ter guardado o seu ficheiro:

php cecil.phar build

De seguida, volte à página para ver o resultado:

Modificação do seu posto de trabalho

Se preferir utilizar o seu editor de código habitual, ligue-se com um cliente FTP no seu servidor para recuperar os ficheiros no seu computador:

Pode agora editar os ficheiros no seu I.D.E.:

Basta-lhe reencaminhar os seus ficheiros alterados ou os seus novos ficheiros para o seu servidor e de rebuilder para ter as suas páginas online.

Adicionar a página gerada ao menu do seu site

Para adicionar esta nova página ao menu do website, modifique manualmente o cabeçalho do ficheiro .md, adicionando a seguinte linha:

menu: main

Conclusão

Cecil é uma ferramenta que permite construir um site estático de forma eficiente a partir de ficheiros Markdown, linguagem de balizagem mais simples de implementar que o HTML. A organização dos ficheiros Markdown condiciona a hierarquia das suas páginas web.
A utilização de um motor de template, muito utilizado na comunidade de programadores web, permitir-lhe-á encontrar facilmente várias fontes na Internet para conceber uma interface de aspeto profissional.

Quer saber mais?

Adicionar conteúdo dinâmico a uma página web estática gerada com Cecil

O site oficial da aplicação Cecil

Um guia sobre o formato Markdown

Nosso guia sobre a utilização do FileZilla

Para serviços especializados (referenciamento, desenvolvimento, etc), contacte os parceiros OVHcloud.

Fale com nossa comunidade de utilizadores.