Nesta oficina iremos conhecer o essencial para publicação de páginas HTML estáticas e a utilização do Jekyll, um popular gerador de blogs e websites estáticos. O GitBook é uma alternativa conveniente caso o interesse seja também a criação de PDFs e ePUBs.

As atividades desta oficina estão separadas em duas partes. Antes do encontro presencial cada participante deve garantir a capacidade de publicar arquivos na web e dispor de um comando ou script que automatiza a publicação de arquivos em um servidor web. O encontro presencial será focado na instalação e uso do Jekyll, por isto é importante atenção aos exercícios preparatórios.

Requisitos

Para participar da oficina de Documentação de projetos utilizando o Jekyll é importante que você seja capaz de copiar arquivos para um diretório acessível publicamente por um navegador web. Familiarização com o bash (terminal), ssh e Markdown são recomendados.

Tipicamente você irá trabalhar na documentação do seu projeto e seu website Jekyll em seu computador. Quando fizeres alguma alteração e desejas atualizar o site, deverá copiar os arquivos que foram modificados para o servidor. São propostos três exercícios que visam garantir que você tem um local para publicar seu website Jekyll e que dispôe de um mecanismo ágil de sincronização de arquivos do seu computador com o servidor.

Para fazer melhor proveito da oficina de Jekyll é importante que tenha realizado ao menos os exercícios 1 e 3. Antes da oficina prepare seu computador, garantindo funcionamento do script e acesso ao servidor web.