Repolode
Enviar
danielfrg

danielfrg/mkdocs-jupyter

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.

Ver en GitHubSitio web
Estrellas
509
Forks
65
Issues abiertos
0
Último commit
hace 3 días

¿Qué es?

mkdocs-jupyter permite añadir Jupyter Notebooks directamente a la navegación de un sitio MkDocs, para que los tutoriales y los análisis puedan convivir con las páginas habituales en Markdown. Acepta archivos .ipynb y scripts de Python en formato Jupytext, y los muestra con el mismo estilo que la salida estándar de Jupyter Notebook, con compatibilidad para temas de Jupyter e ipywidgets.

El plugin puede ejecutar los notebooks antes de convertirlos, excluir archivos concretos de la ejecución y ocultar las entradas de código o los prompts de forma global o por celda mediante etiquetas. Los títulos de los notebooks y las entradas del índice se generan a partir de los encabezados, y el frontmatter YAML permite establecer los metadatos de página estándar de MkDocs. Las fórmulas se muestran con MathJax y los resultados de la conversión se guardan en caché entre compilaciones.

Está pensado para sitios de documentación donde los ejemplos de código deben poder ejecutarse y mostrar sus resultados, sin tener que mantener archivos HTML exportados por separado.

Funciones clave

  • 01Añade archivos .ipynb y .py de Jupytext directamente a la navegación de MkDocs.
  • 02Ejecuta los notebooks antes de convertirlos de forma opcional, con exclusiones por archivo.
  • 03Oculta las entradas de código o los prompts de forma global o en celdas etiquetadas.
  • 04Es compatible con temas de Jupyter, ipywidgets y la representación de fórmulas con MathJax.
  • 05Incluye un enlace para descargar el código fuente del notebook y guarda en caché los resultados de la conversión.

Casos de uso

  • Publicar tutoriales de ciencia de datos con código ejecutable y resultados visibles en un sitio de documentación.
  • Crear documentación de API o bibliotecas que incluya ejemplos ejecutables.
  • Redactar publicaciones técnicas de blog o material para cursos en formato notebook con MkDocs.

Inicio rápido

  1. 1

    Instala el plugin desde PyPI

    pip install mkdocs-jupyter
  2. 2

    Añade el plugin a plugins en mkdocs.yml e incluye tus notebooks o archivos .py en nav

Antes de usarlo

  • Solo funciona como plugin para MkDocs, por lo que necesitas un sitio de MkDocs existente.

En colecciones

Generadores de sitios estáticos y herramientas de documentación

Temas

#jupyter#mkdocs#documentation#python#notebook#static-site#blogging#jupyter-notebook

Preguntas frecuentes

¿Qué es mkdocs-jupyter?
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. mkdocs-jupyter permite añadir Jupyter Notebooks directamente a la navegación de un sitio MkDocs, para que los tutoriales y los análisis puedan convivir con las páginas habituales en Markdown. Acepta archivos .ipynb y scripts de Python en formato Jupytext, y los muestra con el mismo estilo que la salida estándar de Jupyter Notebook, con compatibilidad para temas de Jupyter e ipywidgets.
¿mkdocs-jupyter es gratuito? ¿Qué licencia tiene?
mkdocs-jupyter es open source bajo la licencia Apache-2.0. Revisa los términos de la licencia antes de usarlo en productos comerciales.
¿mkdocs-jupyter sigue mantenido?
Mantenimiento activo. El último commit de mkdocs-jupyter fue el 5 nov 2026.
¿Para qué puedo usar mkdocs-jupyter?
Publicar tutoriales de ciencia de datos con código ejecutable y resultados visibles en un sitio de documentación. Crear documentación de API o bibliotecas que incluya ejemplos ejecutables. Redactar publicaciones técnicas de blog o material para cursos en formato notebook con MkDocs.
¿Cómo se instala mkdocs-jupyter?
Instala el plugin desde PyPI: pip install mkdocs-jupyter Añade el plugin a plugins en mkdocs.yml e incluye tus notebooks o archivos .py en nav
¿Dónde consigo mkdocs-jupyter?
El código fuente y las instrucciones de instalación están en GitHub: https://github.com/danielfrg/mkdocs-jupyter

Resumen generado por IA a partir del README del proyecto. Las estadísticas de GitHub se actualizan a diario.

Proyectos relacionados