convert Markdown to HTML
Project description
MarkdownParser
MarkdownParser 是一个 Markdown 语法解析器,用于实现 md 到 html 标签的转换
安装
pip install markdownparser
快速使用
import MarkdownParser
html = MarkdownParser.parse('# Hello World!')
print(html)
#<div class='markdown-body'><h1>Hello World!</h1></div>
接口函数
# 解析 markdown 文本转 html
def parse(text: str) -> str:
# 解析 md 文件转 html
def parse_file(file_name: str) -> str:
# 解析 markdown 文本, 带目录树
def parse_toc(text: str) -> str:
# 解析 md 文件, 带目录树
def parse_file_toc(file_name: str) -> str:
接口类 Markdown, Block
结果预览与 Markdown 功能测试
本仓库下提供了了一个快速验证转换结果的工具 generate.py
python generate.py <FILE_NAME>
# python generate.py ./testfiles/md/test1.md
# python generate.py README.md
运行会生成index.html, 使用浏览器打开生成的index.html即可与您预期的渲染结果对比, README 的渲染结果如下所示
实现思路
您可通过取消 core.py 注释来获取树的结构
def parse(self, text: str) -> str:
# 去除空行/注释/html标签
lines = self.preprocess_parser(text)
# print(lines)
# 逐行解析,得到一颗未优化的树
root = self.block_parser(lines)
# root.info()
# 优化,得到正确的markdown解析树
tree = self.tree_parser(root)
# tree.info()
# 输出到屏幕 / 导出html文件
return tree.toHTML()
不支持
- 四个空格变为代码段
- [^1]的引用方式
- Setext 形式的标题
- 上标 / 下标 / 下划线
<details><summary></summary></details>折叠块
HTML 结果说明
-
生成的结果会以 "markdown-body" 类名的一个
div包裹例如
<div class='markdown-body'>markdown内容</div> -
代码段会根据语言为 pre 加入一个类名便于后期高亮,例如
class="language-cpp", 未定义语言则为language-UNKNOWN -
默认导出的HTML中层级任务列表会有显示问题,这是因为使用了ul+li+checkbox的方式,您需要添加以下css样式修正
.markdown-body > ul>li:has(input) { padding-left: 0; margin-bottom: 0; } .markdown-body ul>li:has(input)>ul { list-style-type: none; padding-left: 8px; }
-
您可以使用
parse_toc将 HashHeadBlock 提取出来组成目录树, 得到一个<div class="header-navigator">...</div>并添加到返回的 HTML 元素中, 您可能还需要一些 js 相关的代码实现跳转, 具体可以参考 template.htmllet links = document.querySelectorAll('div a[href^="#"]'); links.forEach(link => { link.addEventListener('click', function(event) { event.preventDefault(); let target = document.querySelector(this.getAttribute('href')); target.scrollIntoView({ behavior: 'smooth' }); }); });
以及一些样式美化
.header-navigator { position: fixed; }
-
如果您想添加对Mermaid的支持, 您可参考mermaid plugin在您的html页面
<body>末尾添加如下<script><script type="module"> const codeBlocks = document.querySelectorAll('.language-mermaid'); codeBlocks.forEach(codeBlock => { codeBlock.classList.remove('language-mermaid'); codeBlock.classList.add('mermaid'); }); import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.esm.min.mjs'; mermaid.initialize({ startOnLoad: true }); </script>
请注意, 由于本Markdown解析器的CodeBlock解析得到的类名为
language-mermaid, 而mermaid插件支持的类名格式为mermaid, 所以代码中手动修改了language-mermaid的类名 -
如果您想添加对Latex数学公式的支持, 可以在html页面
<body>末尾添加如下<script><script> MathJax = { tex: { inlineMath: [['$', '$'], ['\\(', '\\)']] } }; </script> <script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-chtml.js"> </script>
注意,这里仅支持很少一部分数学公式
参考
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file markdownparser-0.5.35.tar.gz.
File metadata
- Download URL: markdownparser-0.5.35.tar.gz
- Upload date:
- Size: 17.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.5.1 CPython/3.10.9 Windows/10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a2a50f70d277b3ecb235452dfce20d6fc39b29229f7dcc2829940777cd6b1a9d |
|
| MD5 | f129564009f71137c088872bee79f6b2 |
|
| BLAKE2b-256 | 99dc0e2c8043e281c6a8e156fa1f9c7fc2880d8b198bab78a75572df1f6dcb6a |
File details
Details for the file markdownparser-0.5.35-py3-none-any.whl.
File metadata
- Download URL: markdownparser-0.5.35-py3-none-any.whl
- Upload date:
- Size: 20.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.5.1 CPython/3.10.9 Windows/10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 6d597b25683237b9ed5e623dbfa3941a85960e8341c8e3488ade96aa5eff6d89 |
|
| MD5 | ce0be3297f0bb0a7e8b8de581c1f9b41 |
|
| BLAKE2b-256 | 501273c1015b2d11744c8a128f383b39ed6ce20802b651445e88e495acf77cdf |
