diff --git a/README.md b/README.md index 6b8c77a..9853767 100644 --- a/README.md +++ b/README.md @@ -13,11 +13,35 @@ A seguir temos a lista de repositórios utilizados pelo time de desenvolvimento ## Contribuidores -| Foto | Nome | Github | Email | -| :--: | :--: | :----: | :---: | -| | Arthur Ferreira | [ArthurFerreiraRodrigues](https://github.com/ArthurFerreiraRodrigues) | arthur.250402@gmail.com | -| | Cristian Furtado | [csafurtado](htwidth="200px"tps://github.com/csafurtado) | cristiansafurtado@gmail.com | -| | Ester Lino | [esteerlino](https://github.com/esteerlino) | esteerlino@gmail.com | -| | Pedro Cabeceira | [pkbceira03](https://github.com/pkbceira03) | cabeceira2003@gmail.com | -| | Raissa Oliveira | [raissamsoliveira](https://github.com/raissamsoliveira) | raissa.menezesousa@gmail.com | -| | Wildemberg Sales | [wildemberg-sales](https://github.com/wildemberg-sales) | wildemberg.sales.junior@gmail.com | + +| Foto | Nome | Github | Email | +| :----------------------------------------------------------: | :--------------: | :-------------------------------------------------------------------: | :-------------------------------: | +| | Arthur Ferreira | [ArthurFerreiraRodrigues](https://github.com/ArthurFerreiraRodrigues) | arthur.250402@gmail.com | +| | Cristian Furtado | [csafurtado](htwidth="200px"tps://github.com/csafurtado) | cristiansafurtado@gmail.com | +| | Ester Lino | [esteerlino](https://github.com/esteerlino) | esteerlino@gmail.com | +| | Pedro Cabeceira | [pkbceira03](https://github.com/pkbceira03) | cabeceira2003@gmail.com | +| | Raissa Oliveira | [raissamsoliveira](https://github.com/raissamsoliveira) | raissa.menezesousa@gmail.com | +| | Wildemberg Sales | [wildemberg-sales](https://github.com/wildemberg-sales) | wildemberg.sales.junior@gmail.com | + +## Trabalhando com o MkDocs + +O MkDocs é utilizado para a documentação interna do grupo sobre o trabalho no projeto Querido Diário. Abaixo estão as instruções para instalação e os prováveis comandos que você pode ter que usar ao trabalhar com MkDocs. + +### Instalação + +Além do MkDocs, é utilizado um tema baseado no Material Design, o MkDocs Material. Portanto, ele também será necessário ser instalado. + +Para instalar o MkDocs e o MkDocs Material, você precisará do Python e do pip. Com esses dois instalados, você pode rodar o seguinte comando: + +```bash +pip install mkdocs mkdocs-material +``` + +### Comandos + +- `mkdocs serve` - Inicia o servidor de documentação com live-reload. +- `mkdocs build` - Gera a documentação estática. + +#### Deploy + +Não é necessário realizar o deploy manualmente, pois o deploy é feito automaticamente pelo GitHub Actions. A cada push na branch `master`, o GitHub Actions gera a documentação estática e a publica na branch `gh-pages`. A documentação estática pode ser acessada [aqui](https://residenciaticbrisa.github.io/T2G4-Querido-Diario/). diff --git a/docs/images/arthur-profile.jpg b/docs/images/arthur-profile.jpg new file mode 100644 index 0000000..776ac10 Binary files /dev/null and b/docs/images/arthur-profile.jpg differ