Reestilização do git pages

[Matheuspimentell]

Descrição

O git pages do projeto merece mais atenção visual, por isso, a equipe de front-end se dedicará a reestilizar o git pages para obter um visual mais atrativo e intuitivo.

Tarefas

• [x] Definir protótipo / template.
• [x] Iniciar o desenvolvimento do novo gitpages.

Critérios de aceitação

• [x] O novo template do gitpages deve ter sido confirmado.
• [x] A lista de tecnologias necessárias deve estar documentada em forma de comentários nesta issue.
• [x] O novo gitpages deve estar em sua fase inicial de desenvolvimento

[RochaCarla]

Essa issue não é prioiritaria. sugestão: adiar para uma sprint mais tranquila ou quando membros tiverem ociosos na sprint

[guibrbs]

Tem um tema do MkDocs que achei bem interessante, se fizer a substituição da imagem e mudar as cores ficaria ótimo.

Possui também a opção de modo escuro:

Pode encontrar o link aqui

[thiago-vivan]

Segue o link de um repositório sobre criação e customização de temas para o mkDocs https://github.com/mkdocs/mkdocs/blob/master/docs/dev-guide/themes.md

[guibrbs]

Para customizar baseado no template acima, precisamos saber como fazer o "overrides" no mkdocs, segue o link da documentação: https://squidfunk.github.io/mkdocs-material/customization/#overriding-blocks

[guibrbs]

Foi decidido pela equipe que o template a ser utilizado será esse do MkDocs:

Vale ressaltar que o tema que vem por padrão não é o que é descrito na imagem acima, portanto utilizaremos um recurso desse MkDocs Material. Esse recurso trata-se do override, onde poderemos customizar o visual do GitHub Pages através de um "override", que consiste na criação de uma main.html na pasta override e algumas possíveis configurações de CSS e Javascript.

Para customizar baseado no template acima, precisamos saber como fazer o "overrides" no mkdocs, segue o link da documentação: https://squidfunk.github.io/mkdocs-material/customization/#overriding-blocks

[guibrbs]

Foi feito um protótipo da página inicial baseado na ideia do MkDocs Material:

Com isso, ao longo dos próximos dias terá início a reestilização do GitHub Pages do projeto.

[thiago-vivan]

Lista de tecnologias:

Com python instalado rodar o comando "pip install mkdocs"

Para checkar a instalação $ mkdocs --version

Para criar um novo projeto mkdocs new my-project cd my-project

Note que será criado uma pasta com um arquivo "mkdocs.yml" e uma pasta "docs" que irá conter a documentação.

[Matheuspimentell]

A issue atingiu os objetivos desejados.

[guibrbs]

O desenvolvimento inicial do GitHub Pages foi iniciado. Foi criado no outro repositório do INDICAA uma branch "gh-pages", nela contendo os arquivos básicos do MkDocs, bem como algumas estilizações seguindo como base o modelo feito.