MD到HTML转换器

md2html的Python项目详细描述


标记为HTML转换器

这是一个从markdown到html的转换器,具有对markdown表和gfm语法突出显示的高级支持。此包依赖于markdown2将基本标记转换为html,并依赖于pygments支持代码到html的转换,以进行语法突出显示。这个包的默认主题(目前仅限)是monokai。

您可以在https://mcautograder.cpyles.com找到从该包生成的站点的示例。

安装

使用pip安装转换器:

pip install md2html

用法

此包是一个可从命令行运行的可执行文件:

md2html ...

以下是此文件的帮助条目:

usage: md2html [-h] [-s SITE] [-n NAV] ...

convert Markdown to HTML

positional arguments:
  files                 files to be converted to HTML

optional arguments:
  -h, --help            show this help message and exit
  -s SITE, --site-info SITE
                        add metadata to the HTML files
  -n NAV, --nav NAV     add a YAML file to use for navigation menu

运行转换器将把html文件放在与标记文件相同的目录中,并用.md扩展名替换为.html。html文件在head中的style标记中附带css。

页面元数据

如果要向页面添加元数据(包括导航菜单),请创建包含此元数据的yaml文件并将文件路径传递给-s标志,例如

md2html -s meta.yml ...

yaml文件的结构应该是:

title:page titleauthor:page authordescription:page descriptionnavigation:nav_title:navigation menu titlelinks:-title:link nameurl:HTML file path-title:...url:......

当前,如果使用此选项,则必须设置title。转换器尚不支持导航子菜单,因此所有链接都将呈现为

导航菜单

转换器还支持只添加导航菜单而不添加页面元数据。为此,请将yaml文件传递给-n标志。它应该具有以下结构:

nav_title:navigation menu titlelinks:-title:link nameurl:HTML file path-title:...url:......

更改日志

v1.0:

  • 更改为boostrap css

v0.1:

  • 初始版本

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
java如何使用Ibatis在插入时返回ID(使用返回关键字)   java(org.hibernate.TransactionException)org。冬眠TransactionException:事务未成功启动   java小程序jwindow始终位于JNLP顶部   在Java中重新解析JSON对象?   java单击后将ListView数据移动到新屏幕   Mule ESB中的java WSA寻址特性   Java,对象编程:获取返回0值的方法   hibernate的Java通用问题,如何处理T get(K id)   java在使用超级CSV读取CSV时忽略引用   ssh使用Java远程运行命令   java如何向具体用户发送websocket消息?   在JAVA中,我可以在不指定的情况下使用条件运算符吗?