Python Code Playground en MkDocs: cómo hacer que la documentación cobre vida | por Kay Jan Wong | agosto de 2024

Dando vida a la documentación

Imagen 1: Python Code Playground en Mkdocs en mi documentación — Imagen del autor

Inspirado en los patios de juegos de codificación en vivo, donde los usuarios pueden codificar en el sitio web en lugar de descargar el lenguaje de programación o el software, ¿qué tan genial sería tenerlo en la documentación de MkDocs y tener su paquete de Python disponible en un “conecta y reproduce” ¿modo?

La documentación debe tener como mínimo una guía técnica y de usuario, junto con un glosario y notas de la versión. La documentación realmente puede cobrar vida ¡Si los lectores pueden interactuar con el código directamente en la documentación!

Después de buscar en Internet, me di cuenta de que los patios de juegos de codificación son más fáciles de configurar con JavaScript, mientras que mi documentación de MkDocs y toda la base de código estaban en Python. Después de mucho buscar, encontré Este foro con lo que quería, pero el área de juegos estaba muy codificada para funcionar con otro paquete de Python. Decidí adaptarlo a un solución genérica y lo explicaré más detalladamente paso a paso sobre lo que se necesita y lo que se puede modificar para que funcione para usted.

Nota: Estos son los enlaces a la patio de juegos y mi código basePuede encontrar enlaces más útiles en la sección “Enlaces relacionados” al final de este artículo.