Ejecutar en el sandbox

API de Markdown a HTML#

La API de Markdown a HTML convierte un archivo Markdown en un documento HTML con estilos completos con una sola solicitud a POST /v1/convert/markdown-to-html. Sube un archivo .md o .markdown mediante un formulario multipart y recibe una página HTML completa y autocontenida con CSS incrustado, diseño responsivo y un botón de modo oscuro integrado, lista para abrir en cualquier navegador. El HTML se devuelve directamente por defecto, o establece direct_download=false para obtener metadatos JSON con una URL de descarga prefirmada.

Endpoint#

POST /v1/convert/markdown-to-html

Content-Type: multipart/form-data

Entrada aceptada: archivos .md o .markdown (codificados en UTF-8)

Formato de salida: .html (text/html)

Autenticación#

Requiere una clave API privada o un token JWT obtenido de una clave pública.

X-API-Key: sk_your_private_key

O bien:

Authorization: Bearer <jwt_token>

Parámetros de la solicitud#

Parámetro	Tipo	Obligatorio	Predeterminado	Descripción
`file`	file	Sí	--	El archivo `.md` o `.markdown` a convertir. Debe estar codificado en UTF-8.
`output_filename`	`string`	No	Nombre del archivo de entrada	Nombre de archivo de salida personalizado. La extensión `.html` se añade automáticamente.
`direct_download`	`boolean`	No	`true`	Con `true`, devuelve el documento HTML directamente. Con `false`, devuelve metadatos JSON con una URL de descarga prefirmada.

Reglas de conversión#

El conversor usa Python-Markdown con las siguientes extensiones habilitadas:

Extensión	Qué hace
`tables`	Tablas Markdown delimitadas por barras verticales renderizadas como elementos `<table>` de HTML
`fenced_code`	Bloques de código con triple acento grave e identificadores de lenguaje (```python)
`codehilite`	Clases CSS de resaltado de sintaxis en los bloques de código (mediante Pygments)
`toc`	Generación de tabla de contenidos mediante un marcador `[TOC]` en tu documento
`attr_list`	Añade atributos HTML a los elementos con la sintaxis `{.class #id}`

Ejemplo#

Entrada:

# My Document

[TOC]

## Introduction

This is a **bold** and *italic* example.

## Data Table

| Name  | Age | City   |
|-------|-----|--------|
| Alice | 30  | London |
| Bob   | 25  | Paris  |

## Code Sample

```python
def hello():
    print("Hello, world!")
```

Salida: Un documento <!DOCTYPE html> completo con:

El Markdown renderizado dentro de un <body> con ancho máximo de 800px y diseño centrado
Tablas, bloques de código, enlaces y encabezados con estilos
Una tabla de contenidos clicable generada a partir de los encabezados
Un botón de modo oscuro (esquina superior derecha) que guarda la preferencia del usuario en localStorage

Estilos de salida#

El HTML generado incluye un bloque <style> incrustado con:

Temas claro y oscuro mediante propiedades CSS personalizadas, alternados por un atributo data-theme
Pila de fuentes del sistema (-apple-system, BlinkMacSystemFont, Segoe UI, Arial, sans-serif)
Diseño responsivo con ancho máximo de 800px y contenido centrado
Interlineado de 1.6 para mejorar la legibilidad
Elementos con estilos: bloques de código (con fondo), tablas (con bordes y filas alternadas), enlaces y citas

Nota sobre el resaltado de sintaxis: La extensión codehilite añade nombres de clase CSS de Pygments a los bloques de código, pero la salida no incluye ninguna hoja de estilos de Pygments. Los bloques de código tendrán la estructura correcta y estilos básicos, pero el resaltado de colores por lenguaje requiere añadir un tema CSS de Pygments a la página. En cualquier caso, los estilos integrados aportan fondo y tipografía a todos los bloques de código.

Respuesta#

Descarga directa (`direct_download=true`, predeterminado)#

HTTP 200 OK
Content-Type: text/html
Content-Disposition: inline; filename="readme_20260405_123456789.html"

Devuelve el documento HTML completo. Como el Content-Disposition es inline, los navegadores renderizan la página directamente.

Respuesta con metadatos (`direct_download=false`)#

{
    "presigned_url": "https://spaces.example.com/...",
    "object_key": "env/files/{project_id}/markdown-to-html/readme_20260405_123456789.html",
    "filename": "readme_20260405_123456789.html",
    "file_size": 5678,
    "conversion_time_seconds": 0.04
}

Ejemplos de código#

Python#

import requests

with open("README.md", "rb") as f:
    response = requests.post(
        "https://api.enconvert.com/v1/convert/markdown-to-html",
        headers={"X-API-Key": "sk_your_private_key"},
        files={"file": ("README.md", f, "text/markdown")}
    )

with open("README.html", "wb") as out:
    out.write(response.content)

Node.js#

const form = new FormData();
form.append("file", fs.createReadStream("README.md"));

const response = await fetch("https://api.enconvert.com/v1/convert/markdown-to-html", {
    method: "POST",
    headers: { "X-API-Key": "sk_your_private_key" },
    body: form
});

const html = await response.text();
fs.writeFileSync("README.html", html);

PHP#

$ch = curl_init("https://api.enconvert.com/v1/convert/markdown-to-html");
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ["X-API-Key: sk_your_private_key"],
    CURLOPT_POSTFIELDS => ["file" => new CURLFile("README.md", "text/markdown")]
]);
$html = curl_exec($ch);
curl_close($ch);
file_put_contents("README.html", $html);

Go#

body := &bytes.Buffer{}
writer := multipart.NewWriter(body)
part, _ := writer.CreateFormFile("file", "README.md")
file, _ := os.Open("README.md")
io.Copy(part, file)
writer.Close()

req, _ := http.NewRequest("POST", "https://api.enconvert.com/v1/convert/markdown-to-html", body)
req.Header.Set("Content-Type", writer.FormDataContentType())
req.Header.Set("X-API-Key", "sk_your_private_key")
resp, _ := http.DefaultClient.Do(req)

JavaScript -- Navegador (clave pública)#

const tokenRes = await fetch("https://api.enconvert.com/v1/auth/token", {
    method: "POST",
    headers: { "X-API-Key": "pk_your_public_key" }
});
const { token } = await tokenRes.json();

const form = new FormData();
form.append("file", fileInput.files[0]);

const response = await fetch("https://api.enconvert.com/v1/convert/markdown-to-html", {
    method: "POST",
    headers: { "Authorization": `Bearer ${token}` },
    body: form
});

const data = await response.json();
window.open(data.presigned_url, "_blank");

Respuestas de error#

Estado	Condición
`400 Bad Request`	El archivo no es un archivo `.md` o `.markdown`
`400 Bad Request`	Codificación Markdown no válida (se espera UTF-8)
`400 Bad Request`	La conversión de Markdown a HTML falló
`401 Unauthorized`	Clave API o token JWT ausente o no válido
`402 Payment Required`	Cuota mensual de ops agotada
`402 Payment Required`	Límite de almacenamiento alcanzado
`413 Payload Too Large`	El archivo supera el tamaño máximo del plan

Límites#

Límite	Valor
Tamaño máximo de archivo	Según el plan (Founding: 5 MB)
Codificación de entrada	Solo UTF-8
Extensiones aceptadas	`.md`, `.markdown`
Conversiones mensuales	Según el plan

Preguntas frecuentes#

¿Cómo renderizo Markdown a HTML con una API REST?#

Envía una solicitud POST multipart/form-data a POST /v1/convert/markdown-to-html con tu archivo .md o .markdown en el campo file, autenticándote con una cabecera X-API-Key o un token JWT Authorization: Bearer. Por defecto, la respuesta es un documento HTML completo.

¿La API de Markdown a HTML admite tablas, bloques de código y tabla de contenidos?#

Sí. El conversor usa Python-Markdown con las extensiones tables, fenced_code, codehilite, toc y attr_list habilitadas. Añade un marcador [TOC] en tu documento para generar una tabla de contenidos clicable a partir de los encabezados.

¿Por qué mis bloques de código no tienen colores de resaltado de sintaxis por lenguaje?#

La extensión codehilite añade nombres de clase CSS de Pygments a los bloques de código, pero la salida no incluye ninguna hoja de estilos de Pygments. Añade un tema CSS de Pygments a la página para obtener el resaltado de colores; los estilos integrados aportan de todas formas fondo y tipografía a todos los bloques de código.

¿Puedo convertir Markdown a HTML directamente desde el navegador?#

Sí. Intercambia una clave pública (pk_...) por un JWT mediante POST /v1/auth/token, luego llama al endpoint con una cabecera Authorization: Bearer y abre la presigned_url devuelta.

¿El HTML generado incluye modo oscuro?#

Sí. La salida incluye temas claro y oscuro mediante propiedades CSS personalizadas, alternados por un atributo data-theme, con un botón de modo oscuro que guarda la preferencia del usuario en localStorage.

← xml-to-csv Images →

API Documentation