Repolode
Enviar
GitbookIO

GitbookIO/gitbook

Engine open source de renderização com Next.js que serve sites de documentação publicados no GitBook, com opção de hospedagem própria.

Alternativa open source a:GitBook

Ver no GitHubSite
Estrelas
29,069
Forks
4,039
Issues abertas
91
Último commit
há 21 horas

O que é?

O GitBook é uma plataforma para gerenciar o conhecimento técnico de equipes. Este repositório contém o frontend open source que renderiza o conteúdo publicado no GitBook, permitindo exibir, com este código, um site de documentação criado na plataforma.

O projeto é desenvolvido com Next.js e TypeScript e pode ser executado localmente com Node.js e Bun. Ao iniciar o servidor de desenvolvimento, você pode abrir qualquer espaço publicado no GitBook por meio de uma URL localhost, e as alterações no código aparecem imediatamente no navegador. Testes visuais e de desempenho são executados em pull requests.

É possível hospedar o projeto por conta própria para personalizar a aparência da documentação publicada e incorporá-la ao seu aplicativo. Os mantenedores observam que quem opta pela hospedagem própria fica responsável pela confiabilidade e por acompanhar as mudanças na plataforma, e recomendam essa opção apenas quando essa contrapartida fizer sentido.

Recursos principais

  • 01Renderiza sites de documentação publicados no GitBook a partir do código-fonte.
  • 02Desenvolvido com Next.js e TypeScript.
  • 03Servidor de desenvolvimento local que permite abrir qualquer espaço publicado no GitBook.
  • 04Oferece hospedagem própria com aparência personalizável.
  • 05Inclui arquivos de tradução para a interface do GitBook.

Casos de uso

  • Hospedar por conta própria um site publicado no GitBook em seu próprio domínio.
  • Incorporar documentação renderizada pelo GitBook ao seu próprio aplicativo.
  • Personalizar a aparência da documentação publicada.
  • Contribuir com correções ou traduções para o engine de renderização do GitBook.

Início rápido

  1. 1

    Clone o repositório

    git clone https://github.com/gitbookIO/gitbook.git
  2. 2

    Mude para a versão do Node indicada pelo projeto usando nvm

    nvm use
  3. 3

    Instale as dependências com Bun

    bun install
  4. 4

    Inicie o servidor de desenvolvimento local

    bun dev

Antes de usar

  • É necessário ter Node.js 22.3 ou posterior e Bun 1.2.15 ou posterior.
  • O projeto é licenciado sob GPL-3.0; portanto, para distribuir código modificado, é preciso tornar o código-fonte público ou adquirir uma licença comercial.
  • O README não recomenda a hospedagem própria, e os mantenedores não garantem suporte para forks.

Tópicos

#documentation#markdown#nextjs#typescript#static-site#knowledge-base#git#gitbook

Perguntas frequentes

O que é gitbook?
Engine open source de renderização com Next.js que serve sites de documentação publicados no GitBook, com opção de hospedagem própria. O GitBook é uma plataforma para gerenciar o conhecimento técnico de equipes. Este repositório contém o frontend open source que renderiza o conteúdo publicado no GitBook, permitindo exibir, com este código, um site de documentação criado na plataforma.
gitbook é gratuito? Qual é a licença?
gitbook é open source sob a licença GPL-3.0. Confira os termos da licença antes de usá-lo em produtos comerciais.
gitbook ainda é mantido?
Manutenção ativa. O último commit de gitbook foi em 21 de out. de 2026.
Para que posso usar gitbook?
Hospedar por conta própria um site publicado no GitBook em seu próprio domínio. Incorporar documentação renderizada pelo GitBook ao seu próprio aplicativo. Personalizar a aparência da documentação publicada. Contribuir com correções ou traduções para o engine de renderização do GitBook.
Como instalar gitbook?
Clone o repositório: git clone https://github.com/gitbookIO/gitbook.git Mude para a versão do Node indicada pelo projeto usando nvm: nvm use Instale as dependências com Bun: bun install Inicie o servidor de desenvolvimento local: bun dev
Onde consigo gitbook?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/GitbookIO/gitbook

Resumo gerado por IA a partir do README do projeto. As estatísticas do GitHub são atualizadas diariamente.

Projetos relacionados