Generación de HTML con Python Markdown

Markdown es un lenguaje de marcado ligero que te permite escribir documentos en un formato de texto plano fácil de leer y escribir, y luego convertirlos en documentos HTML estructurados.

La sintaxis de Markdown es simple e intuitiva, y se usa a menudo para escribir blogs, documentos, archivos README, etc.

Para más contenido sobre Markdown, consulta:Tutorial de Markdown

Python puede usar el módulo markdown para convertir texto Markdown a HTML.


Pasos para convertir Markdown a HTML

1. InstalaciónmarkdownBiblioteca

Primero, necesitamos instalar la bibliotecamarkdownde Python, podemos usarpippara instalarla:

pip install markdown

2. Escribir el script de Python

A continuación se muestra un ejemplo sencillo para convertir texto Markdown a HTML:

Ejemplo

import markdown

# Definir el texto Markdown
md_text = """
# Este es el título
Este es el texto en **negrita**.
Este es el texto en *cursiva*.

- Elemento de lista 1
- Elemento de lista 2

[Haz clic aquí](https://www.example.com) para visitar el sitio web.
"""


# Convertir a HTML
html_output = markdown.markdown(md_text)

# Salida HTML
print(html_output)

El resultado es:

<h1>这是标题</h1>
<p>这是 <strong>加粗</strong> 的文本。  
这是 <em>斜体</em> 的文本。</p>
<ul>
<li>列表项 1</li>
<li>列表项 2</li>
</ul>
<p><a href="../index.html">点击这里</a> 访问网站。</p>

A continuación, podemos escribir un script simple de Python para convertir un archivo Markdown (puedes poner el texto Markdown del ejemplo anterior en un archivo) a un archivo HTML:

Código del archivo convert_markdown_to_html.py:

import markdown

# Leer el archivo Markdown
with open('example.md', 'r', encoding='utf-8') as file:
    markdown_text = file.read()

# Convertir Markdown a HTML
html = markdown.markdown(markdown_text)

# Escribir el HTML en un archivo
with open('example.html', 'w', encoding='utf-8') as file:
    file.write(html)

print(¡El archivo Markdown se ha convertido correctamente en un archivo HTML!)

3. Ejecutar el script

Guarda el código anterior comoconvert_markdown_to_html.pyy luego ejecútalo en la terminal:

python convert_markdown_to_html.py

Después de ejecutarlo,example.mdse convertirá en el archivoexample.html.

Explicación del código:

import markdown: esta línea de código importa la bibliotecamarkdown, que proporciona la función de convertir texto Markdown a HTML.

with open('example.md', 'r', encoding='utf-8') as file:
    markdown_text = file.read()

Este código utiliza la funciónopenpara abrir el archivoexample.md, y lee su contenido en la variablemarkdown_text.

html = markdown.markdown(markdown_text): esta línea de código utiliza la funciónmarkdown.markdown()para convertir texto Markdown a texto HTML.

with open('example.html', 'w', encoding='utf-8') as file:
    file.write(html)

Este código escribe el texto HTML convertido en el archivoexample.html.


Extensiones

markdownes una biblioteca que admite varias extensiones, como tablas, resaltado de código, etc. Puedes habilitar las extensiones de la siguiente manera:

html = markdown.markdown(markdown_text, extensions=['tables', 'fenced_code'])

Puedes personalizar el estilo y la estructura de la salida HTML según sea necesario.

Convertir Markdown a HTML con Python es una herramienta simple y potente que puede ayudarte a automatizar el proceso de generación de documentos. Ya sea escribiendo blogs, documentos o descripciones de proyectos, este método puede mejorar en gran medida tu eficiencia de trabajo. ¡Espero que este artículo te ayude a comenzar rápidamente con la función de conversión de Markdown en Python!


Recursos de referencia

Otras extensiones