Конвертация markdown в html c помощью Python
Markdown-это язык разметки, используемый для упрощения процесса написания контента в удобном для чтения текстовом формате. Это формат может быть преобразован в HTML с помощью специальных программ или библиотек языков программирования для отображения в браузере или другой программе.
Поскольку он использует простой текстовый синтаксис, Markdown совместим с любым текстовым редактором и может преобразовывать заголовки, списки, ссылки и другие компоненты в их соответствующие HTML эквиваленты. Блогеры, авторы учебников и авторы документации широко используют Markdown, а веб-сайты, такие как Github, StackOverflow и Индекс пакетов Python (PyPI), поддерживают его.
В в данной статье мы установим библиотеку Python-Markdown, которая необходима для преобразования Markdown в HTML, а также посмотрим на использование интерфейса командной строки библиотеки Python-Markdown для преобразования Markdown в HTML.
Давайте создадим программу на Python, которая читает файл Markdown, преобразует его содержимое в HTML с помощью функции markdown.markdown() и сохраняет HTML-код в новом файле.
Для этого создадим файл Story.md со следующим содержимым:
# Это заоголовок первого уровня
### А это треьего уровня, а внизу будет ненумерованный список
- Элемент списка №1
- Элемент списка №2
- Элемент списка №3
- Элемент списка №4
**А это текст выделен жирным шрифотом**
А теперь созддим скрипт (convert.py) на языке Python необходимый для преобразорвания нашего файла:
# импортируем библиотеку
import markdown
# открываем файл преобразуем его содержимое в HTML которое помещаем в переменную html
with open('Story.md', 'r') as f:
text = f.read()
html = markdown.markdown(text)
# записываем содержимое переменной html в файл
with open('Story.html', 'w') as f:
f.write(html)
Здесь мы сначала импортируем пакет markdown. Далее используем функцию open(), чтобы открыть файл Story.md; передача значения 'r' параметру mode показывает, что Python должен открыть его для чтения.
Объект file сохраняется в переменной f, которую можно использовать для ссылки на файл. Затем мы читаем файл и сохраняем его содержимое внутри переменной text. После этого прочитанный текст преобразуется с помощью markdown.markdown(), сохраняя результат в переменной html.
Далее мы открываем новый файл под названием Story.html в режиме записи ('w') — обратите внимание, что этот файл еще не существует — и записываем содержимое переменной html в файл. В результате этого на диске создается и сохраняется новый файл. Использование оператора with при открытии файла гарантирует, что Python закроет его после завершения обработки.
Далее делаем следующее:
# устанавливаем библиотеку
$ pip install markdown
# запускаем скрипт
$ python ./convert.py
В результате получим файл Story.md cо следующим содержимым:
<h1>Это заоголовок первого уровня</h1>
<h3>А это треьего уровня, а внизу будет ненумерованный список</h3>
<ul>
<li>Элемент списка №1</li>
<li>Элемент списка №2</li>
<li>Элемент списка №3</li>
<li>Элемент списка №4</li>
</ul>
<p><strong>А это текст выделен жирным шрифотом</strong></p>
Теперь посмотрим как использовать интерфейс коммандной строки (CLI) библиотеки Python-Markdown для преобразования файла Markdown в HTML с последующим их сохранением в HTML-файл.
Пример команды ниже, делает тоже самое, что и скрипт, который мы написали выше:
$ python -m markdown Story.md -f Story.html
Таким образом, Markdown - это простой, но в тоже время достаточно мощный формат для форматирования текстов, который можно использовать практически повсеместно, а если Вам не хватит его возможностей, то Вы всегда можете использовать HTML-разметку прямо внутри Markdown файла.
-
Создано 04.03.2021 13:52:41
-
Михаил Русаков
Комментарии (0):
Для добавления комментариев надо войти в систему.
Если Вы ещё не зарегистрированы на сайте, то сначала зарегистрируйтесь.