Repolode
Enviar
timvink

timvink/mkdocs-print-site-plugin

Plugin do MkDocs que adiciona uma página de impressão com todas as páginas do site para exportar facilmente como PDF ou HTML independente.

Ver no GitHubSite
Estrelas
189
Forks
30
Issues abertas
13
Último commit
há 3 dias

O que é?

mkdocs-print-site-plugin é um plugin para o MkDocs, o gerador de sites estáticos em Python para documentação. Ele gera uma página extra que reúne todas as páginas de um site em um único documento, permitindo salvar toda a documentação como um único PDF ou arquivo HTML independente.

A página de impressão fica disponível em /print_page/ ou print_page.html. Os PDFs são gerados ao imprimir essa página pelo navegador, e o plugin inclui paginação para a saída em PDF, além de opções para uma página de capa e a aparência. Ele funciona com os temas mkdocs-material, mkdocs-materialx e readthedocs, e oferece suporte ao plugin autorefs. Sua única dependência é o mkdocs.

Adicione o plugin ao final da lista de plugins em mkdocs.yml para incluir na saída combinada as alterações de navegação feitas por outros plugins.

Recursos principais

  • 01Adiciona uma página de impressão que reúne todas as páginas do site em um único documento
  • 02Exporta para PDF pela caixa de diálogo de impressão do navegador ou para HTML independente
  • 03Oferece suporte à paginação em PDFs e a uma página de capa opcional
  • 04Funciona com os temas mkdocs-material, mkdocs-materialx e readthedocs
  • 05Oferece suporte ao plugin autorefs
  • 06Requer apenas mkdocs como dependência

Casos de uso

  • Disponibilizar uma versão completa da documentação do site do projeto em PDF para uso offline
  • Distribuir a documentação em um único arquivo HTML independente
  • Produzir manuais prontos para impressão a partir de um site de documentação baseado em MkDocs

Início rápido

  1. 1

    Instale o plugin com pip

    pip3 install mkdocs-print-site-plugin
  2. 2

    Adicione print-site ao final da lista de plugins em mkdocs.yml

  3. 3

    Acesse /print_page/ ou print_page.html no seu site para ver a página de impressão combinada

Antes de usar

  • A exportação da página de impressão para PDF depende da função de impressão do seu navegador.

Em coleções

Ferramentas de PDF, OCR e documentosGeradores de sites estáticos e ferramentas de documentação

Tópicos

#mkdocs#mkdocs-plugin#pdf#documentation#static-site#python#pdfs#print

Perguntas frequentes

O que é mkdocs-print-site-plugin?
Plugin do MkDocs que adiciona uma página de impressão com todas as páginas do site para exportar facilmente como PDF ou HTML independente. mkdocs-print-site-plugin é um plugin para o MkDocs, o gerador de sites estáticos em Python para documentação. Ele gera uma página extra que reúne todas as páginas de um site em um único documento, permitindo salvar toda a documentação como um único PDF ou arquivo HTML independente.
mkdocs-print-site-plugin é gratuito? Qual é a licença?
mkdocs-print-site-plugin é open source sob a licença MIT. Confira os termos da licença antes de usá-lo em produtos comerciais.
mkdocs-print-site-plugin ainda é mantido?
Manutenção ativa. O último commit de mkdocs-print-site-plugin foi em 4 de nov. de 2026.
Para que posso usar mkdocs-print-site-plugin?
Disponibilizar uma versão completa da documentação do site do projeto em PDF para uso offline Distribuir a documentação em um único arquivo HTML independente Produzir manuais prontos para impressão a partir de um site de documentação baseado em MkDocs
Como instalar mkdocs-print-site-plugin?
Instale o plugin com pip: pip3 install mkdocs-print-site-plugin Adicione print-site ao final da lista de plugins em mkdocs.yml Acesse /print_page/ ou print_page.html no seu site para ver a página de impressão combinada
Onde consigo mkdocs-print-site-plugin?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/timvink/mkdocs-print-site-plugin

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

Projetos relacionados