rendimentobasico.pt

Sistema experimental para alojar o site http://rendimentobasico.pt

Detalhes de implementação

Este site é alojado através da plataforma GitHub Pages, que usa o sistema Jekyll para gerar páginas estáticas a partir de ficheiros markdown.

Isto permite várias vantagens:

Alojamento gratuito
Estrutura transparente do site (sem código de servidor)
Facilidade na escrita de conteúdo (formatação Markdown)
Facilidade na colaboração (alterações podem ser feitas diretamente na interface web do GitHub)
Controlo de versões e backup de versões anteriores (graças uso implícito do git)

Metadados do site e tema visual

A configuração básica do site encontra-se no ficheiro _config.yml. Este ficheiro define parâmetros usados pelo Jekyll — nomeadamente, o título e descrição do site, e o estilo visual, que neste caso é baseado no tema minimal do GitHub Pages.

O Jekyll dá acesso a estes metadados através de variáveis, como {{site.title}} ou {{site.theme}}, que podem ser usadas em qualquer página do site, para construir links, títulos, etc.

Também existem variáveis específicas do GitHub, acessíveis através no domínio site.hgithub, como por exemplo {{site.github.repository_url}}.

Configuração da estrutura e aparência

Os principais ficheiros que determinam a estrutura e a aparência das páginas são os layouts (templates HTML) e as folhas de estilo CSS.

Os layouts disponíveis encontram-se na pasta _layouts; de momento apenas um é usado, _layouts/default.html.
Os estilos disponíveis encontram-se na pasta assets/css. O estilo principal é o assets/css/style.scss As regras de estilos podem ser escritos quer em CSS quer em SCSS.

Metadados das páginas

O Jekyll requer que todas as páginas em Markdown tenham um bloco de metadados no início, demarcados por três traços:

---
title: Título da página
layout: post
---

Esta é uma página que usa o layout "post". Os layouts disponíveis encontram-se na pasta `_layouts`.

Estes dados podem ser omitidos, mas os demarcadores devem-se manter:

---
---

Esta é uma página sem metadados associados, que usa o layout "default".

Os dados das páginas podem ser acedidos através de variáveis do Jekyll — por exemplo:

{{page.title}}
{{page.layout}}
{{page.content}}
{{page.url}}
{{page.path}}
etc.

Testar alterações localmente

Para a maior parte das alterações, bastará editar os ficheiros diretamente no browser, usando a interface web do GitHub.

No entanto, alterações mais abrangentes podem ser testadas localmente, usando ferramentas da linha de comandos.

Os passos para montar o site localmente são os seguintes:

[Ubuntu] Instalar o Ruby e os pacotes de desenvolvimento necessários:
sudo apt install ruby ruby-dev zlib1g-dev nodejs
(Opcional) Configurar o gem para fazer instalações mais rápidas:
echo -e " install: --no-ri --no-rdoc\n update: --no-ri --no-rdoc" >> ~/.gemrc
Instalar o Bundler:
sudo gem install bundler
Clonar o repositório do site e entrar na pasta:
git clone https://github.com/waldyrious/rendimentobasico.pt.git && cd rendimentobasico.pt
[macOS] Caso o xz tenha sido instalado via Homebrew, instalar o Nokogiri manualmente:
brew unlink xz && sudo gem install nokogiri && brew link xz
Instalar o Jekyll e restantes dependências do GitHub Pages:
sudo bundle install

Estes passos preparatórios só têm que ser corridos uma vez. (Periodicamente convém comando bundle update na pasta do site, para manter as dependências todas em dia.)

A partir de agora, para lançar um servidor local e visualizar o site final, basta correr o comando jekyll serve e abrir o endereço localhost:4000 no browser. Para parar o servidor, usa-se o comando Ctrl+C.

Alterações aos ficheiros originais (markdown) são automaticamente detectadas e o site atualizado. Este processo pode demorar alguns segundos.

Em alternativa, pode ser usado o comando jekyll build, que gera o site de forma estática numa pasta chamada _site, que pode ser aberta no browser e navegada normalmente, sem iniciar um servidor local.

waldyrious / rendimentobasico.pt Goto Github PK