Utilizamos o Docusaurus para gerar uma documentação do nosso site!
Nela você pode encontrar toda a estrutura geral do site, dentre componentes, estruturas de dados, funções implementadas e páginas, além de algumas formas de contribuir com o nosso projeto.
Caso queira também contribuir com a nossa documentação basta seguir os passos abaixo para rodar o projeto na sua máquina:
- Fork o repositório!
Você pode fazer o fork direto aqui na página do repositório ou utilizando o GitHub CLI com o comando abaixo:
gh repo fork elasComputacao/DocsSiteElas
- Clone o repositório para sua máquina!
Caso você tenha utilizado o GitHub CLI, é possível apenas escolher também clonar o repositório na hora do fork. Caso contrário use o comando abaixo:
git clone https://github.com/seu_user/DocsSiteElas.git
- Rodando na sua máquina!
Com o repositório clonado em sua máquina, entre no diretório do projeto:
cd DocsSiteElas
Depois vá até o diretório website:
cd website
Por fim, rode o seguinte comando:
npm start
O site começará a rodar em localhost:3000.
Seguimos a estrutura padrão do Docusaurus. Você pode encontrar essa estruturação aqui.