Skip to content

Markdown

Parse frontmatter, convert to HTML, and generate table of contents.

3 modules

ModuleDescription
Analizar FrontmatterExtrae frontmatter YAML del contenido Markdown
Markdown a HTMLConvierte texto Markdown a HTML
Generar tabla de contenidosGenera una tabla de contenidos a partir de encabezados de Markdown

Modules

Analizar Frontmatter

markdown.parse_frontmatter

Extrae frontmatter YAML del contenido Markdown

Parameters:

NameTypeRequiredDefaultDescription
textstringYes-Contenido Markdown con frontmatter

Output:

FieldTypeDescription
frontmatterobjectFrontmatter analizado como un diccionario
contentstringContenido Markdown sin frontmatter

Example: Parse YAML frontmatter

yaml
text: ---
title: Hello World
date: 2024-01-01
tags:
  - python
  - markdown
---

# Hello World

Content here.

Markdown a HTML

markdown.to_html

Convierte texto Markdown a HTML

Parameters:

NameTypeRequiredDefaultDescription
textstringYes-Contenido Markdown para convertir
extensionsarrayNo-Extensiones de Markdown para habilitar (solo se usa con la biblioteca markdown)

Output:

FieldTypeDescription
htmlstringContenido HTML convertido
word_countnumberConteo de palabras del texto de entrada

Example: Convert markdown to HTML

yaml
text: # Hello

This is **bold** and *italic*.

Generar tabla de contenidos

markdown.toc

Genera una tabla de contenidos a partir de encabezados de Markdown

Parameters:

NameTypeRequiredDefaultDescription
textstringYes-Contenido Markdown para extraer encabezados
max_depthnumberNo3Profundidad máxima de encabezado a incluir (1-6)

Output:

FieldTypeDescription
tocarrayLista de encabezados con nivel, título y slug
toc_markdownstringTabla de contenidos en Markdown formateada

Example: Generate TOC from markdown

yaml
text: # Introduction

## Getting Started

### Installation

### Configuration

## Usage

## API Reference
max_depth: 3

Released under the Apache 2.0 License.