gitbook
1.0.0
Docs - Comunidade - Desenvolvedor Docs - Changelog - relatórios de bug
Bem -vindo ao GitBook, a plataforma para gerenciar o conhecimento técnico para as equipes.
Este repositório contém o código -fonte aberto usado para renderizar o conteúdo publicado do GitBook.
Começando
Contribuindo
Tipos de contribuições
Licenciamento
Agradecimentos
Legacy GitBook
Para executar uma versão local deste projeto, siga estas etapas simples.
Node.js (versão:> = 18.x)
BUN
Clone o repositório em um repositório público do GitHub. Se você planeja distribuir o código, mantenha o código -fonte público para cumprir o GNU GPLV3. Para clonar em um repositório privado, adquira uma licença comercial.
git clone https://github.com/gitbookIO/gitbook.git
Verifique se você está usando a versão do node do projeto. A execução do nvm use alterará sua versão local para a correta.
Instale as dependências do projeto através da BUN.
bun install
Inicie seu servidor de desenvolvimento local.
bun dev
Abra um espaço do Gitbook publicado em seu navegador da web, prefixando -o com http://localhost:3000/ .
Exemplos:
http: // localhost: 3000/docs.gitbook.com
http: // localhost: 3000/open-ource.gitbook.io/midjourney
Qualquer site publicado no GitBook pode ser acessado por meio da instância de desenvolvimento local, e quaisquer atualizações que você fizer na base de código serão refletidas no seu navegador.
bun format : formate o código
bun lint : fie o código
Todas as solicitações de tração serão testadas contra testes visuais e de performances para evitar regressões.
O mecanismo de renderização do GitBook é totalmente de código aberto e construído no topo do próximo.js. Vá ao nosso guia contribuinte para saber mais sobre o fluxo de trabalho para adicionar sua primeira solicitação de tração.
Incentivamos você a contribuir com o GitBook para nos ajudar a criar a melhor ferramenta para documentar o conhecimento técnico. Se você está procurando algumas maneiras rápidas de contribuir, continue lendo para aprender mais sobre contribuições populares.
A interface do usuário do GitBook é renderizada usando um conjunto de arquivos de tradução encontrados em packages/gitbook/src/intl/translations . Congratulamo -nos com todas as traduções adicionais para a interface do usuário.
Encontre um bug ou encontrar um problema que você gostaria de corrigir? Ajudar -nos a corrigir questões relacionadas ao GitBook melhora muito a experiência para todos. Vá para a seção de problemas deste repositório para saber mais sobre os tipos de bugs com os quais você já pode ajudar.
Aviso
Embora seja possível auto-hospedar este projeto, não recomendamos isso, a menos que você tenha certeza de que essa opção se adapta à sua necessidade.
Procurando adicionar um recurso específico no GitBook? Vá para o nosso guia contribuinte para começar.
Auto-hospedar este projeto coloca a responsabilidade de manter e mesclar atualizações futuras sobre você . Não podemos garantir suporte, manutenção ou atualizações para instâncias bifurcadas e auto-hospedadas deste projeto.
Queremos tornar o mais fácil possível para a nossa comunidade colaborar e empurrar o futuro do GitBook, e é por isso que o incentivamos a contribuir diretamente para o nosso produto, em vez de criar sua própria versão.
Este projeto permite que você se auto-hospede a parte de renderização do seu conteúdo publicado no Gitbook. A auto-hospedagem tem prós e contras.
No lado profissional, você pode personalizar a aparência do seu conteúdo e melhor incorporar sua documentação em seu aplicativo.
Por outro lado, você se torna responsável pela confiabilidade do seu site publicado e mantendo o renderizador atualizado com as alterações feitas na plataforma Gitbook.
Distribuído sob a licença GNU GPLV3.
Se você planeja distribuir o código, deve tornar o código -fonte público para cumprir o GNU GPLV3. Para clonar em um repositório privado, adquira uma licença comercial.
Consulte LICENSE para obter mais informações.
[! [Gitbook] (https://img.shields.io/static/v1?message=documented%20on%20gitbook&logo=gitbook&logocolor=fffffffffffffff89a1)
<a href="https://gitbook.com"><imgsrc="https://img.shields.io/static/v1?message=Documented%20on%20GitBook&logo=gitbook&logoColor=ffffff&label=%20&labelColor=5c5c5c&color=3F89A1 "
/> </a>O GitBook não seria possível sem esses projetos:
Next.js
BUN
Tailwind CSS
Motivo de Framer
Nossa versão anterior do GitBook e sua ferramenta CLI agora estão precedentes. Você ainda pode visualizar o antigo repositório e ele é cometidos nesta filial.
