2021-07-20 16:05:52 +00:00
# Como trabalhar no tema da documentação
2021-02-23 05:16:09 +00:00
2021-07-20 16:05:52 +00:00
> [!NOTE] Um lembrete rápido de que você não precisa configurar nada para ajudar no conteúdo da documentação do site.
2021-02-25 01:55:27 +00:00
>
2021-07-20 16:05:52 +00:00
> Para trabalhar nas diretrizes de contribuição, você pode editar ou adicionar arquivos no diretório `docs` [disponível aqui](https://github.com/freeCodeCamp/freeCodeCamp/tree/main/docs). Ao fazermos o merge de suas alterações, elas são disponibilizadas automaticamente no site da documentação.
2021-02-23 05:16:09 +00:00
2021-07-20 16:05:52 +00:00
## Estrutura do site da documentação
2021-02-23 05:16:09 +00:00
2021-07-20 16:05:52 +00:00
O site é gerado usando [`docsify` ](https://docsify.js.org ) e veiculado usando GitHub Pages.
2021-02-23 05:16:09 +00:00
2021-07-20 16:05:52 +00:00
Normalmente, você não precisaria alterar nenhuma configuração ou compilar o site localmente. Caso esteja interessado, funciona assim:
2021-02-23 05:16:09 +00:00
2021-07-20 16:05:52 +00:00
- A fonte da página inicial para este site está disponível em [`docs/index.html` ](index.html ).
- Veiculamos este arquivo como uma SPA usando `docsify` e GitHub Pages.
2021-07-26 14:18:32 +00:00
- O script do `docsify` gera o conteúdo dos arquivos em `markdown` no diretório `docs` sob demanda.
2021-07-20 16:05:52 +00:00
- A página inicial é gerada a partir do [`_coverpage.md` ](_coverpage.md ).
- a navegação da barra lateral é gerada a partir de [`_sidebar.md` ](_sidebar.md ).
2021-02-23 05:16:09 +00:00
2021-07-20 16:05:52 +00:00
## Veiculando localmente o site da documentação
2021-02-23 05:16:09 +00:00
2021-07-20 16:05:52 +00:00
Clone o freeCodeCamp:
2021-02-23 05:16:09 +00:00
```console
git clone https://github.com/freeCodeCamp/freeCodeCamp.git
docsify serve docs
```
2021-07-20 16:05:52 +00:00
Instale o `docsify` :
2021-02-23 05:16:09 +00:00
```console
npm install -g docsify
```
2021-07-20 16:05:52 +00:00
e veicule o diretório `/docs`
2021-02-23 05:16:09 +00:00
```console
docsify serve docs
```
2021-07-20 16:05:52 +00:00
Como alternativa, se você tiver instalado o freeCodeCamp localmente (veja o guia de instalação local), nós empacotamos o CLI com as ferramentas de desenvolvimento para que você possa executar qualquer um dos comandos abaixo, conforme necessário, a partir da raiz do repositório:
2021-02-23 05:16:09 +00:00
2021-07-20 16:05:52 +00:00
### Veicule e inicie apenas o site da documentação
2021-02-23 05:16:09 +00:00
```console
npm run docs:serve
```
2021-07-20 16:05:52 +00:00
### Veicule localmente o site da documentação juntamente com o freeCodeCamp:
2021-02-23 05:16:09 +00:00
```console
npm run develop
```
2021-07-20 16:05:52 +00:00
> O site da documentação deve estar disponível em <http://localhost:3200>
