seed-br / seed-br.github.io

Website
MIT License
1 stars 4 forks source link

Site do Grupo SEED.BR

Rodar site local usando docker

Instale Docker, Docker Compose e execute o comando abaixo.

docker-compose up

Então acesse o site em:

Atualização do site

O site SEED.BR está hospedado no GitHub Pages e é atualizado automaticamente a cada novo commit no repositório abaixo:

Organização do código-fonte do site

O site do SEED.BR é feito com o gerador de site estático Jekyll versão 4.2.0 e o código-fonte está organizado segundo a estrutura abaixo.

Arquivo ou Pasta Descricao
_config.yml Arquivo de configuração do Jekyll
css/ Pasta com arquivos de estilo CSS
docker-compose.yml Arquivo docker compose para rodar site localmente para desenvolvimento
files/ Arquivos de imagens, videos, outros
_includes/ Arquivos de templade HTML do Jekyll para Header, Footer, Menu e outros
index.html Arquivo HTML Jekyll da página inicial do site
javascript/ Pasta com arquivos de Javascript
_layouts/ Pasta com layouts HTML do Jekyll para páginas, blog posts, slides
_pages/ Pasta com arquivos Markdown com conteúdos do site
_posts/ Pasta com arquivos Markdown com conteúdos de Blog ou Notícias
_site/ Pasta com todo o site gerado pelo Jekyll conteudo resultado de build (é o que está publicado em produção)
_slides/ Pasta com slides HTML escritos em Reveal.js
_data/ Pasta com arquivos YAML que armazenam dados estruturados usados para gerar conteúdo dinâmico no site, como a lista de publicações
start.sh Shell script para rodar o site localmente

Como atualizar e contribuir com o site

Para contribuir com o site é necessário fazer um clone do repositório git do site, fazer as modificações desejadas, commit e enviar um Pull Request para o repositório no GitHub.

É possível também enviar commits diretamente via git push sem Pull Request caso você tenha permissão e não precise de revisão de alguém do grupo antes de aplicar as mudanças em produção.

Como adicionar uma nova publicação

Para adicionar uma publicação no site é necessário preencher o arquivo publications.yml na pasta _data/ com os detalhes de cada publicação.

Cada entrada no arquivo representa uma publicação individual e deve incluir as informações da publicação no seguinte formato:

Para adicionar uma nova publicação, copie o formato da entrada e preencha com as informações da nova publicação. Todos os campos devem ser preenchidos.