danielfrg/mkdocs-jupyter

O que é?

Recursos principais

• 01Adiciona arquivos .ipynb e .py do Jupytext diretamente à navegação do MkDocs.
• 02Executa notebooks antes da conversão, de forma opcional, com exclusões por arquivo.
• 03Oculta a entrada de código ou os prompts globalmente ou em células marcadas com tags.
• 04Oferece suporte a temas do Jupyter, ipywidgets e renderização de fórmulas matemáticas com MathJax.
• 05Inclui um link para baixar o código-fonte do notebook e mantém os resultados da conversão em cache.

Casos de uso

• Publicar tutoriais de ciência de dados com código executável e saídas visíveis em um site de documentação.
• Criar documentação de APIs ou bibliotecas com exemplos executáveis.
• Escrever posts técnicos ou material didático no formato de notebook usando MkDocs.

Início rápido

1. 1

   Instale o plugin pelo PyPI

   pip install mkdocs-jupyter
2. 2

   Adicione o plugin a plugins no mkdocs.yml e liste seus notebooks ou arquivos .py em nav

Antes de usar

• !Funciona apenas como plugin para MkDocs, então você precisa ter um site MkDocs existente.

Em coleções

Tópicos

Perguntas frequentes

O que é mkdocs-jupyter?

Plugin do MkDocs que converte Jupyter Notebooks e arquivos .py do Jupytext em páginas de documentação, com execução opcional e suporte a temas. mkdocs-jupyter permite adicionar Jupyter Notebooks diretamente à navegação de um site MkDocs, para que tutoriais e análises fiquem junto às páginas Markdown convencionais. Ele aceita arquivos .ipynb e também scripts Python no formato Jupytext, renderizando-os no mesmo estilo da saída padrão do Jupyter Notebook, com suporte a temas do Jupyter e ipywidgets.

mkdocs-jupyter é gratuito? Qual é a licença?

mkdocs-jupyter é open source sob a licença Apache-2.0. Confira os termos da licença antes de usá-lo em produtos comerciais.

mkdocs-jupyter ainda é mantido?

Manutenção ativa. O último commit de mkdocs-jupyter foi em 5 de nov. de 2026.

Para que posso usar mkdocs-jupyter?

Publicar tutoriais de ciência de dados com código executável e saídas visíveis em um site de documentação. Criar documentação de APIs ou bibliotecas com exemplos executáveis. Escrever posts técnicos ou material didático no formato de notebook usando MkDocs.

Como instalar mkdocs-jupyter?

Instale o plugin pelo PyPI: pip install mkdocs-jupyter Adicione o plugin a plugins no mkdocs.yml e liste seus notebooks ou arquivos .py em nav

Onde consigo mkdocs-jupyter?

O código-fonte e as instruções de instalação estão no GitHub: https://github.com/danielfrg/mkdocs-jupyter