Markdown – Lenguaje Python
Markdown es un lenguaje de marcado común que los desarrolladores utilizan con frecuencia para escribir la documentación de proyectos de Python.
Contrata a un experto en Python para iniciar tu proyecto hoy mismo:
Markdown fue originalmente desarrollado por John Gruber en 2004. El diseño ligero del lenguaje de marcado ayudó a que los desarrolladores y diseñadores de software lo adoptaran rápidamente. La simplicidad del formato también facilita la escritura de analizadores para convertir la sintaxis estructurada a otros formatos como HTML y JSON.
Markdown no tiene un conjunto extenso de reglas estrictas como algunos otros formatos de texto, por lo que debería poder leer los conceptos básicos con estos artículos y luego escribir algunos documentos de práctica para sentirse cómodo con ellos. Los siguientes recursos son realmente útiles cuando está comenzando o necesita una referencia rápida sobre una función de uso menos común, como tablas o citas en bloque.
- Di sí a Markdown, no a MS Word proporciona una descripción general realmente impresionante de por qué Markdown es un formato de archivo más utilizable que Microsoft Word y tipos de archivos patentados similares. El artículo también tiene una buena lista de herramientas útiles relacionadas con Markdown, como Convertidor de Markdown a PDF (un paquete NodeJS pero lo suficientemente fácil de usar con un entorno de desarrollo básico).
- Sintaxis de Markdown es el estándar de facto y la lectura maravillosa tanto para el aprendizaje inicial como para la referencia aleatoria.
- Hoja de referencia de Markdown es una referencia rápida que es una versión abreviada de la página de sintaxis de Markdown anterior.
- Analizadores de Markdown en Python revisa muchas de las implementaciones más comunes del analizador de Python Markdown para dar una idea de las ventajas y desventajas de cada una.
- reStructuredText vs Markdown para documentación trae algunos puntos realmente buenos sobre las desventajas de la simplicidad de Markdown. En primer lugar, una gran cantidad de documentación necesita una salida más compleja que no es posible con Vanilla Markdown, por lo que debe pasar a HTML antiguo simple, que frustra el propósito de usar un lenguaje de marcado. En segundo lugar, parte de la sintaxis relacionada con la inserción de líneas en blanco agregando espacios al final de las líneas es confusa si alguien está usando un editor de texto o un entorno de desarrollo que no está configurado para mostrar espacios en blanco. Peor aún, si su editor está configurado para eliminar los espacios en blanco al final de las líneas, lo cual es bastante común entre los desarrolladores, entonces puede romper por error el formato que pretendía el autor original. En general, esta es una buena pieza para leer para obtener una visión equilibrada de Markdown y las razones que proporciona son una de las razones por las que utilizo Markdown y reStructuredText dependiendo del proyecto.
- El índice de paquetes de Python (PyPI) admite Markdown a partir de 2018 aunque todavía se están realizando algunos ajustes en los sabores que se pueden usar, como Markdown con sabor a GitHub.
- PowerShell y Markdown muestra cómo trabajar con Markdown en PowerShell, incluida la personalización de colores y una lista de algunas peculiaridades que puede necesitar para solucionar.
- reStructuredText vs Markdown para documentación técnica compara Markdown y reStructuredText específicamente para documentar software y explica dónde tiene ventajas cada uno.
- Alcance Markdown, no LaTeX examina las virtudes de utilizar Markdown directo junto con herramientas como pandoc para convertir de un formato de archivo a otro, incluido cómo usar Markdown para presentaciones y no solo documentación regular.
- Página de Markdown es un archivo JavaScript que facilita la reproducción simple de Markdown como una página web.
¿Necesitas ayuda para revisar el código de tu proyecto?
También te puede interesar:
Esta entrada tiene 0 comentarios