Skip to content

seed-br/seed-br.github.io

Repository files navigation

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:

  • title: o título completo da publicação.
  • authors: os nomes dos autores da publicação em um array.
  • published_in: um objeto contendo:
    • name: o nome do evento ou revista onde a publicação foi lançada.
    • url: o link para o evento ou revista
  • year: o ano em que a publicação foi lançada.
  • doi: o DOI (Digital Object Identifier) da publicação.
  • type: o tipo de publicação, como livro, capítulo de livro, artigo de conferência, etc.

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.

Como adicionar um novo membro no grupo

Para adicionar um novo membro no grupo é necessário criar um novo arquivo markdown na pasta _members com os detalhes do novo membro.

Cada arquivo representa um membro e deve incluir as informações abaixo:

  • layout: member: o layout utilizado para visualização da página de membero. Todos os membros devem utilizar o layout member.
  • title: Researchers: título da página.
  • name: o nome do pesquisador.
  • nickname: como o nome do pesquisador será citado nas publicações.
  • role: o papel do membro no grupo. Atualmente temos "Research Group Leader", "Master's student" e "Ph.D. student"
  • photo: o caminho da foto do pesquisador. A foto deve estar na pasta /assets/images/members/.
  • social_links: lista de links que serão listados na página. Cada link deve ser listado com name e url.
  • bio: um texto com informações sobre o membro.
  • research_interests: lista dos interesses de pesquisa do membro.
  • education: lista com informações sobre a formação acadêmica do membro. Cada formação deve ser listada com degree, institution e year.
  • current_research: texto com informações sobre as pesquisas atuais do membro.