Plugin de MkDocs que genera documentación de referencia de API directamente a partir de los docstrings del código fuente mediante handlers específicos para cada lenguaje.
2,1 mil+2 esta semana126PythonISCActualizado hace 15 días
timvink/mkdocs-print-site-plugin
Un plugin de MkDocs que agrega una página de impresión con todas las páginas del sitio para exportarlas fácilmente a PDF o HTML independiente.
- Estrellas
- 189
- Forks
- 30
- Issues abiertos
- 13
- Último commit
- hace 3 días
¿Qué es?
mkdocs-print-site-plugin es un plugin para MkDocs, el generador de sitios estáticos de documentación escrito en Python. Genera una página adicional que concatena todas las páginas de un sitio en un solo documento, para que toda la documentación se pueda guardar como un único PDF o archivo HTML independiente.
La página de impresión está disponible en /print_page/ o print_page.html. Los PDF se generan al imprimir esa página desde un navegador, y el plugin incluye paginación para la salida en PDF, además de opciones para configurar una portada y la apariencia. Funciona con los temas mkdocs-material, mkdocs-materialx y readthedocs, y es compatible con el plugin autorefs. Su única dependencia es mkdocs.
Agrega el plugin al final de la lista de plugins en mkdocs.yml para incluir en el resultado combinado los cambios que otros plugins hagan en la navegación.
Funciones clave
- 01Agrega una página de impresión que combina todas las páginas del sitio en un solo documento
- 02Exporta a PDF mediante el diálogo de impresión del navegador o a HTML independiente
- 03Admite paginación en los PDF y una portada opcional
- 04Funciona con los temas mkdocs-material, mkdocs-materialx y readthedocs
- 05Es compatible con el plugin autorefs
- 06Solo requiere mkdocs como dependencia
Casos de uso
- Ofrecer una versión PDF completa y sin conexión de la documentación de un proyecto
- Distribuir la documentación en un único archivo HTML independiente
- Crear manuales imprimibles a partir de un sitio de documentación basado en MkDocs
Inicio rápido
- 1
Instala el complemento con pip
pip3 install mkdocs-print-site-plugin - 2
Añade print-site al final de la lista de complementos en mkdocs.yml
- 3
Abre /print_page/ o print_page.html en tu sitio para ver la página de impresión combinada
Antes de usarlo
- La exportación de la página de impresión a PDF depende de la función de impresión de tu navegador.
En colecciones
Temas
Preguntas frecuentes
- ¿Qué es mkdocs-print-site-plugin?
- Un plugin de MkDocs que agrega una página de impresión con todas las páginas del sitio para exportarlas fácilmente a PDF o HTML independiente. mkdocs-print-site-plugin es un plugin para MkDocs, el generador de sitios estáticos de documentación escrito en Python. Genera una página adicional que concatena todas las páginas de un sitio en un solo documento, para que toda la documentación se pueda guardar como un único PDF o archivo HTML independiente.
- ¿mkdocs-print-site-plugin es gratuito? ¿Qué licencia tiene?
- mkdocs-print-site-plugin es open source bajo la licencia MIT. Revisa los términos de la licencia antes de usarlo en productos comerciales.
- ¿mkdocs-print-site-plugin sigue mantenido?
- Mantenimiento activo. El último commit de mkdocs-print-site-plugin fue el 4 nov 2026.
- ¿Para qué puedo usar mkdocs-print-site-plugin?
- Ofrecer una versión PDF completa y sin conexión de la documentación de un proyecto Distribuir la documentación en un único archivo HTML independiente Crear manuales imprimibles a partir de un sitio de documentación basado en MkDocs
- ¿Cómo se instala mkdocs-print-site-plugin?
- Instala el complemento con pip: pip3 install mkdocs-print-site-plugin Añade print-site al final de la lista de complementos en mkdocs.yml Abre /print_page/ o print_page.html en tu sitio para ver la página de impresión combinada
- ¿Dónde consigo mkdocs-print-site-plugin?
- El código fuente y las instrucciones de instalación están en GitHub: https://github.com/timvink/mkdocs-print-site-plugin
Resumen generado por IA a partir del README del proyecto. Las estadísticas de GitHub se actualizan a diario.
Proyectos relacionados
Un tema Material Design para MkDocs que convierte archivos Markdown en un sitio de documentación estático, adaptable y con búsqueda.
27,6 mil+8 esta semana4,2 milPythonMITActualizado hace 8 días
Un plugin de MkDocs que convierte Jupyter Notebooks y archivos .py de Jupytext en páginas de documentación, con ejecución opcional y estilos de temas.
50965Jupyter NotebookApache-2.0Bien mantenidoActualizado anteayer
Wiki gratuita, abierta y en constante actualización que enseña programación competitiva (OI e ICPC), desde algoritmos básicos hasta temas avanzados.
27,1 mil+51 esta semana4,7 milTypeScriptSin licenciaActualizado hace 22 horas
Wiki bilingüe chino-inglés sobre finanzas cuantitativas, con modelos de trading cuantitativo, algoritmos, modelos de factores y estrategias, creada con MkDocs.
4,4 mil+25 esta semana350Sin licenciaActualizado hace 7 meses
Plataforma de código abierto que compila, versiona y aloja automáticamente documentación desde repositorios Git, con compatibilidad con Sphinx y MkDocs.
8,4 mil+1 esta semana3,7 milPythonMITBien mantenidoActualizado anteayer