Skip to content

Markdown

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

3 modules

ModuleDescription
Phân tích FrontmatterTrích xuất YAML frontmatter từ nội dung Markdown
Markdown sang HTMLChuyển đổi văn bản Markdown sang HTML
Tạo Mục lụcTạo mục lục từ các tiêu đề trong Markdown

Modules

Phân tích Frontmatter

markdown.parse_frontmatter

Trích xuất YAML frontmatter từ nội dung Markdown

Parameters:

NameTypeRequiredDefaultDescription
textstringYes-Nội dung Markdown có frontmatter

Output:

FieldTypeDescription
frontmatterobjectFrontmatter đã phân tích dưới dạng từ điển
contentstringNội dung Markdown không có frontmatter

Example: Parse YAML frontmatter

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

# Hello World

Content here.

Markdown sang HTML

markdown.to_html

Chuyển đổi văn bản Markdown sang HTML

Parameters:

NameTypeRequiredDefaultDescription
textstringYes-Nội dung Markdown để chuyển đổi
extensionsarrayNo-Tiện ích mở rộng Markdown để kích hoạt (chỉ dùng với thư viện markdown)

Output:

FieldTypeDescription
htmlstringNội dung HTML đã chuyển đổi
word_countnumberSố từ của văn bản đầu vào

Example: Convert markdown to HTML

yaml
text: # Hello

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

Tạo Mục lục

markdown.toc

Tạo mục lục từ các tiêu đề trong Markdown

Parameters:

NameTypeRequiredDefaultDescription
textstringYes-Nội dung Markdown để trích xuất tiêu đề
max_depthnumberNo3Độ sâu tiêu đề tối đa để bao gồm (1-6)

Output:

FieldTypeDescription
tocarrayDanh sách tiêu đề với cấp độ, tiêu đề và slug
toc_markdownstringMục lục Markdown đã định dạng

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.