Repolode
Enviar
alex-shpak

alex-shpak/hugo-book

Um tema simples e compatível com dispositivos móveis para documentação no gerador de sites estáticos Hugo, com visual de livro tradicional.

Ver no GitHubSite
Estrelas
4,097
Forks
1,311
Issues abertas
8
Último commit
ontem

O que é?

Hugo Book é um tema para o gerador de sites estáticos Hugo que transforma conteúdo em Markdown em um site de documentação com um layout limpo, semelhante ao de um livro. Ele oferece uma árvore de navegação na barra lateral, uma estrutura otimizada para buscas e modos claro e escuro, além de funcionar sem nenhuma configuração inicial.

O tema inclui shortcodes integrados para elementos comuns de documentação, oferece suporte a sites multilíngues e traz páginas simples de blog e taxonomia. Os recursos principais funcionam sem JavaScript, e o projeto busca não interferir nos layouts definidos pelo usuário e dar preferência a CSS em vez de JS sempre que possível.

Há um repositório inicial disponível para agilizar a configuração. O tema requer Hugo v0.158 ou superior e usa versões menores no estilo SemVer; mudanças incompatíveis podem ocorrer entre versões.

Recursos principais

  • 01Layout limpo, com estilo de livro e navegação na barra lateral
  • 02Design responsivo e compatível com dispositivos móveis
  • 03Suporte a sites multilíngues
  • 04Shortcodes integrados para elementos comuns de documentação
  • 05Os recursos principais funcionam sem JavaScript
  • 06Modos claro e escuro

Casos de uso

  • Criar documentação de projetos ou produtos com Hugo
  • Criar um site de documentação multilíngue
  • Publicar um manual técnico simples ou uma base de conhecimento

Início rápido

  1. 1

    Clone o repositório inicial

    git clone https://github.com/alex-shpak/hugo-book-starter my-docs
  2. 2

    Acesse a pasta do projeto

    cd my-docs
  3. 3

    Obtenha o submódulo do tema

    git submodule update --init --remote
  4. 4

    Inicie o servidor de desenvolvimento do Hugo

    hugo server --minify

Antes de usar

  • São esperadas mudanças incompatíveis entre versões, então as atualizações podem exigir alterações no site.

Tópicos

#documentation#hugo#hugo-theme#markdown#static-site

Perguntas frequentes

O que é hugo-book?
Um tema simples e compatível com dispositivos móveis para documentação no gerador de sites estáticos Hugo, com visual de livro tradicional. Hugo Book é um tema para o gerador de sites estáticos Hugo que transforma conteúdo em Markdown em um site de documentação com um layout limpo, semelhante ao de um livro. Ele oferece uma árvore de navegação na barra lateral, uma estrutura otimizada para buscas e modos claro e escuro, além de funcionar sem nenhuma configuração inicial.
hugo-book é gratuito? Qual é a licença?
hugo-book é open source sob a licença MIT. Confira os termos da licença antes de usá-lo em produtos comerciais.
hugo-book ainda é mantido?
Manutenção ativa. O último commit de hugo-book foi em 21 de out. de 2026.
Para que posso usar hugo-book?
Criar documentação de projetos ou produtos com Hugo Criar um site de documentação multilíngue Publicar um manual técnico simples ou uma base de conhecimento
Como instalar hugo-book?
Clone o repositório inicial: git clone https://github.com/alex-shpak/hugo-book-starter my-docs Acesse a pasta do projeto: cd my-docs Obtenha o submódulo do tema: git submodule update --init --remote Inicie o servidor de desenvolvimento do Hugo: hugo server --minify
Onde consigo hugo-book?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/alex-shpak/hugo-book

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

Projetos relacionados