Skip to content

Markdown

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

3 modules

ModuleDescription
फ्रंटमैटर पार्स करेंMarkdown सामग्री से YAML फ्रंटमैटर निकालें
Markdown से HTMLMarkdown पाठ को HTML में बदलें
सामग्री की तालिका बनाएंMarkdown शीर्षकों से सामग्री की तालिका बनाएं

Modules

फ्रंटमैटर पार्स करें

markdown.parse_frontmatter

Markdown सामग्री से YAML फ्रंटमैटर निकालें

Parameters:

NameTypeRequiredDefaultDescription
textstringYes-फ्रंटमैटर के साथ Markdown सामग्री

Output:

FieldTypeDescription
frontmatterobjectडिक्शनरी के रूप में पार्स किया गया फ्रंटमैटर
contentstringफ्रंटमैटर के बिना Markdown सामग्री

Example: Parse YAML frontmatter

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

# Hello World

Content here.

Markdown से HTML

markdown.to_html

Markdown पाठ को HTML में बदलें

Parameters:

NameTypeRequiredDefaultDescription
textstringYes-बदलने के लिए Markdown सामग्री
extensionsarrayNo-Markdown विस्तार सक्षम करने के लिए (केवल markdown लाइब्रेरी के साथ उपयोग किया जाता है)

Output:

FieldTypeDescription
htmlstringबदला हुआ HTML सामग्री
word_countnumberइनपुट पाठ की शब्द गणना

Example: Convert markdown to HTML

yaml
text: # Hello

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

सामग्री की तालिका बनाएं

markdown.toc

Markdown शीर्षकों से सामग्री की तालिका बनाएं

Parameters:

NameTypeRequiredDefaultDescription
textstringYes-शीर्षक निकालने के लिए Markdown सामग्री
max_depthnumberNo3शामिल करने के लिए अधिकतम शीर्षक गहराई (1-6)

Output:

FieldTypeDescription
tocarrayस्तर, शीर्षक, और स्लग के साथ शीर्षकों की सूची
toc_markdownstringस्वरूपित 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.