Skip to main content

Library for parcing markdown and convert to html text or file.

Project description

py-markdown

Library for parcing markdown and convert to html text or file.

Библиотека для парсинга markdown-файла и его преобразование в html-текст или файл.

Установка библиотеки

Установка библиотеки осуществляется без всяких зависимостей:

pip install parce-markdown

После успешной установки импортируем библиотеку в файл:

import py_markdown as md

Работа с исходным текстом

Теперь преобразуем текст c markdown-разметкой в html. Для этого создадим экземпляр класса ReadMD:

TEXT = "# Header of MD\nMarkdown is a super-simple text presentation format."
obj: md.MD = md.ReadMD(TEXT)

Распознать markdown-файл можно с помощью классового метода file_import:

PATH = "README.md"
obj: md.MD = md.ReadMD.file_import(PATH)

По умолчанию установлена кодировка utf-8.

Представление html-разметки

Чтобы преобразовать markdown-разметку в html-разметку можно воспользоваться следующим методом:

result: str = obj.to_html_text()

Чтобы преобразовать markdown-разметку в html-файл воспользуемся следующим методом:

PATH_EXPORT = "/export/sample.html"
obj.to_html_file(PATH_EXPORT)

Представленные методы позволяют успростить и автоматизировать создание html-контента, освоив только азы разметки markdown, а также LaTex-запись формул.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

parce_markdown-0.0.4b0.tar.gz (3.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

parce_markdown-0.0.4b0-py3-none-any.whl (4.5 kB view details)

Uploaded Python 3

File details

Details for the file parce_markdown-0.0.4b0.tar.gz.

File metadata

  • Download URL: parce_markdown-0.0.4b0.tar.gz
  • Upload date:
  • Size: 3.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.11.9

File hashes

Hashes for parce_markdown-0.0.4b0.tar.gz
Algorithm Hash digest
SHA256 de770ae9d882eee0b72dd917daf9bfb88baf5b30c63cbea8ea39d4a496acd8ab
MD5 0561b6c28f48e81a04de718987e20d2c
BLAKE2b-256 c4255c72fe571119f239acd8b7fd8baa70df44d7035ad916a51313f77eb32e99

See more details on using hashes here.

File details

Details for the file parce_markdown-0.0.4b0-py3-none-any.whl.

File metadata

File hashes

Hashes for parce_markdown-0.0.4b0-py3-none-any.whl
Algorithm Hash digest
SHA256 1072887ebc139fcaced547c97fecf2eb886fe94401330e68f6c07679ba97ff31
MD5 ed3315e74c6b8e08d24142983feb6e89
BLAKE2b-256 228d5d710f605b0145ebd6e063a1666c29ac834bbfee30f1b142f5504efb4591

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page