Este repositório contém o código fonte da página https://exbolsistas.org.
Esta página é contruida usando MkDocs e o tema Material for MkDocs.
Veja https://exbolsistas.org/faça-parte/ ou docs/faça-parte.md.
Ainda não temos uma documentação sobre como contribuir com o Núcleo, e ainda não definimos uma licença para o conteúdo desse repositório, mas sinta-se a vontade para enviar sugestões através de GitHub issues e Pull Requests.
Para servir a página localmente (i.e. no seu computador), é necessário um ambiente capaz de rodar containers com Docker Compose (e.g., com Docker Desktop ou Podman Desktop), ou um ambiente capaz de rodar scripts em Python (testado com Python 3).
Abaixo seguem as instruções para ambas a opções de ambiente de desenvolvimento.
Após clonar esse repositório, use o comando docker compose up ou docker-compose up.
A página estará disponível no endereço http://localhost:8000/.
Para evitar conflito com outros ambientes de desenvolvimento locais, as intruções abaixo fazem uso de ambientes virtuais (https://docs.python.org/3/library/venv.html).
Após clonar esse repositório, use os seguintes comandos em um terminal/linha de comando na raiz do repositório:
python3 -m venv .devenv- Em um prompt do Windows (Command Prompt, cmd.exe):
.devenv\Scripts\activate.bat
Verifique https://docs.python.org/3/library/venv.html#how-venvs-work para instruções para outros terminais, linhas de comando e sistemas
pip3 install mkdocs-material==9.5.33
Depois de seguir as instruções acima, você pode servir o site com o comando mkdocs serve.
A página estará disponível no endereço http://localhost:8000/.
Se você sair da linha de comando, será necessário ativar novamente o ambiente virtual, com o comando da instrução número 2.
Nota: O nome de ambiente .devenv foi escolhido arbitrariamente.