Skip to content

Markdown

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

3 modules

ModuleDescription
Analizza FrontmatterEstrai frontmatter YAML dal contenuto Markdown
Markdown a HTMLConverti testo Markdown in HTML
Genera IndiceGenera un indice dai titoli Markdown

Modules

Analizza Frontmatter

markdown.parse_frontmatter

Estrai frontmatter YAML dal contenuto Markdown

Parameters:

NameTypeRequiredDefaultDescription
textstringYes-Contenuto Markdown con frontmatter

Output:

FieldTypeDescription
frontmatterobjectFrontmatter analizzato come dizionario
contentstringContenuto Markdown senza 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

Converti testo Markdown in HTML

Parameters:

NameTypeRequiredDefaultDescription
textstringYes-Contenuto Markdown da convertire
extensionsarrayNo-Estensioni Markdown da abilitare (usate solo con la libreria markdown)

Output:

FieldTypeDescription
htmlstringContenuto HTML convertito
word_countnumberConteggio parole del testo di input

Example: Convert markdown to HTML

yaml
text: # Hello

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

Genera Indice

markdown.toc

Genera un indice dai titoli Markdown

Parameters:

NameTypeRequiredDefaultDescription
textstringYes-Contenuto Markdown da cui estrarre i titoli
max_depthnumberNo3Profondità massima dei titoli da includere (1-6)

Output:

FieldTypeDescription
tocarrayElenco di titoli con livello, titolo e slug
toc_markdownstringIndice formattato in 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.