Skip to content

Markdown

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

3 modules

ModuleDescription
Analyser le FrontmatterExtraire le frontmatter YAML du contenu Markdown
Markdown en HTMLConvertir le texte Markdown en HTML
Générer la table des matièresGénérer une table des matières à partir des titres Markdown

Modules

Analyser le Frontmatter

markdown.parse_frontmatter

Extraire le frontmatter YAML du contenu Markdown

Parameters:

NameTypeRequiredDefaultDescription
textstringYes-Contenu Markdown avec frontmatter

Output:

FieldTypeDescription
frontmatterobjectFrontmatter analysé sous forme de dictionnaire
contentstringContenu Markdown sans frontmatter

Example: Parse YAML frontmatter

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

# Hello World

Content here.

Markdown en HTML

markdown.to_html

Convertir le texte Markdown en HTML

Parameters:

NameTypeRequiredDefaultDescription
textstringYes-Contenu Markdown à convertir
extensionsarrayNo-Extensions Markdown à activer (utilisées uniquement avec la bibliothèque markdown)

Output:

FieldTypeDescription
htmlstringContenu HTML converti
word_countnumberNombre de mots du texte d'entrée

Example: Convert markdown to HTML

yaml
text: # Hello

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

Générer la table des matières

markdown.toc

Générer une table des matières à partir des titres Markdown

Parameters:

NameTypeRequiredDefaultDescription
textstringYes-Contenu Markdown pour extraire les titres
max_depthnumberNo3Profondeur maximale des titres à inclure (1-6)

Output:

FieldTypeDescription
tocarrayListe des titres avec niveau, titre et identifiant
toc_markdownstringTable des matières formatée en Markdown

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.