Skip to content

Markdown

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

3 modules

ModuleDescription
Ön Maddeyi AyrıştırMarkdown içeriğinden YAML ön maddeyi çıkar
Markdown'dan HTML'yeMarkdown metnini HTML'ye dönüştür
İçindekiler Tablosu OluşturMarkdown başlıklarından içindekiler tablosu oluştur

Modules

Ön Maddeyi Ayrıştır

markdown.parse_frontmatter

Markdown içeriğinden YAML ön maddeyi çıkar

Parameters:

NameTypeRequiredDefaultDescription
textstringYes-Ön madde içeren Markdown içeriği

Output:

FieldTypeDescription
frontmatterobjectSözlük olarak ayrıştırılmış ön madde
contentstringÖn madde olmadan Markdown içeriği

Example: Parse YAML frontmatter

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

# Hello World

Content here.

Markdown'dan HTML'ye

markdown.to_html

Markdown metnini HTML'ye dönüştür

Parameters:

NameTypeRequiredDefaultDescription
textstringYes-Dönüştürülecek Markdown içeriği
extensionsarrayNo-Etkinleştirilecek Markdown uzantıları (sadece markdown kütüphanesi ile kullanılır)

Output:

FieldTypeDescription
htmlstringDönüştürülmüş HTML içeriği
word_countnumberGirdi metninin kelime sayısı

Example: Convert markdown to HTML

yaml
text: # Hello

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

İçindekiler Tablosu Oluştur

markdown.toc

Markdown başlıklarından içindekiler tablosu oluştur

Parameters:

NameTypeRequiredDefaultDescription
textstringYes-Başlıkları çıkarmak için Markdown içeriği
max_depthnumberNo3Dahil edilecek maksimum başlık derinliği (1-6)

Output:

FieldTypeDescription
tocarraySeviye, başlık ve slug ile başlık listesi
toc_markdownstringBiçimlendirilmiş Markdown içindekiler tablosu

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.