Repolode
rust-lang

rust-lang/mdBook

Ferramenta de linha de comando em Rust que cria livros online a partir de arquivos Markdown, semelhante ao GitBook.

Alternativa open source a:GitBook

Estrelas
22,236
Forks
1,908
Issues abertas
659
Último commit
há 20 horas

O que é?

O mdBook transforma um diretório de arquivos Markdown em um livro online moderno e fácil de navegar. Ele foi pensado para documentação e conteúdo extenso, como guias de programação, e o próprio Guia do Usuário do projeto é criado com a ferramenta.

O projeto é escrito em Rust e distribuído pelo crates.io, então pode ser instalado como um único binário de linha de comando. Os livros são descritos por um arquivo de configuração e um sumário, e o resultado é um site estático que pode ser hospedado em qualquer servidor de arquivos estáticos.

Como trabalha com Markdown puro, o conteúdo continua sob controle de versão e pode ser editado em qualquer editor de texto. A ferramenta é licenciada sob a Mozilla Public License v2.0.

Recursos principais

  • 01Cria um livro HTML estático a partir de arquivos Markdown.
  • 02A estrutura do livro é definida por um arquivo de sumário.
  • 03Pode ser instalado como um único binário de linha de comando em Rust pelo crates.io.
  • 04O resultado é um site estático que pode ser hospedado em qualquer servidor de arquivos estáticos.

Casos de uso

  • Publicar o guia do usuário de uma linguagem de programação ou biblioteca.
  • Escrever documentação interna de engenharia mantida em um repositório Git.
  • Criar um tutorial extenso ou material de curso como um site navegável.

Antes de usar

  • Está licenciado sob a MPL-2.0, uma licença copyleft no nível de arquivo; por isso, os arquivos de código-fonte modificados devem continuar sob a MPL-2.0.

Tópicos

Perguntas frequentes

O que é mdBook?
Ferramenta de linha de comando em Rust que cria livros online a partir de arquivos Markdown, semelhante ao GitBook. O mdBook transforma um diretório de arquivos Markdown em um livro online moderno e fácil de navegar. Ele foi pensado para documentação e conteúdo extenso, como guias de programação, e o próprio Guia do Usuário do projeto é criado com a ferramenta.
mdBook é gratuito? Qual é a licença?
mdBook é open source sob a licença MPL-2.0. Confira os termos da licença antes de usá-lo em produtos comerciais.
mdBook ainda é mantido?
Manutenção ativa. O último commit de mdBook foi em 21 de out. de 2026.
Para que posso usar mdBook?
Publicar o guia do usuário de uma linguagem de programação ou biblioteca. Escrever documentação interna de engenharia mantida em um repositório Git. Criar um tutorial extenso ou material de curso como um site navegável.
Onde consigo mdBook?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/rust-lang/mdBook

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

Projetos relacionados