修复错误
pyMd2Doc的Python项目详细描述
#1.PYMD2DOC简介
使用python将标记转换为具有可伸缩文本内容的目录文档。
#2.使用方法
此程序需要python3或更高版本的python环境。
##2.1准备标记文件
准备需要转换为文档的标记文件。
##2.2安装pymd2doc
使用安装程序
pip install pyMd2Doc
##2.3开始转换
###2.3.1 MD文件到HTML
>;创建[yourfilename].py文件以准备需要转换的标记文件,例如mymarkdown.md
>;引入所需的模块,调用函数并传入要转换的降价文件,如下例所示:
from pymd2doc import createDoc
createDoc.create(“myMarkdown”)
成功执行>;将生成mymarkdown.html文件
###2.3.2字符串MD内容到HTML
>;引入所需的模块,调用函数,并传入需要转换的降价文件
>;传入字符串md内容,如下例所示:
from pymd2doc import createDoc
- STR = u’‘’
- Here is the String md content ‘’‘
# param strs passes in the MD string # param myMarkdown definition will generate the name of the HTML file # return myMarkdown.html
createDoc.createByString(strs, “myMarkdown”)
>;成功执行>;将生成mymarkdown.html文件
##2.4检查文档
打开刚才用浏览器生成的mymarkdown.html文件。
单击目录跳转到相应的文档内容。