基于highlight.js的语法突出显示，用于使用markyp html构建的网页
markyp-highlightjs的Python项目详细描述
markyp highlightjs
基于highlight.js的语法突出显示，用于使用markyp-html构建的网页。
安装
该项目列在python包索引中，只需执行pip install markyp-highlightjs即可安装。
开始
如果您不熟悉markyp的基本概念，请首先查看它的文档here。
下面的代码显示了一个简单网页的创建，该网页显示语法突出显示的python代码。示例中有三点需要注意：
- 选定的主题（css）将添加到文档的头部。
- 语法突出显示的代码是使用
highlight()方法创建的。 - 导入并初始化highlight.js的javascript代码被添加到页面的
javascript部分。
frommarkyp_htmlimportwebpagefrommarkyp_highlightjsimportjs,themes,highlightcode="\n".join(["from markyp_html import webpage","from markyp_highlightjs import js, themes, highlight","page = webpage("," highlight(\"import antigravity\", language=\"python\"),"," page_title=\"markyp-highlightjs demo page\","," head_elements=[themes.darcula],"," javascript=js.js",")","","print(page)"])page=webpage(highlight(code,language="python"),page_title="markyp-highlightjs demo page",head_elements=[themes.github],javascript=js.js)print(page)
有关此包如何工作的详细信息，请参见markyp和markyp-html。
社区指南
一般来说，请相互尊重，并遵循以下准则与项目互动：
- 问题，反馈：用
[Question] <issue-title>标题打开问题。 - bug reports：打开一个带有
[Bug] <issue-title>标题、对bug的充分描述的问题，并在可能的情况下复制该问题的代码片段。 - feature requests and ideas：打开一个带有
[Enhancement] <issue-title>标题和增强建议的清晰描述的问题。
贡献指南
欢迎各种形式的贡献，包括文档改进、测试、错误修复和功能实现。
请遵循以下指导原则为项目做出贡献：
- 确保您的更改与项目的文档和编码样式匹配，包括PEP 484类型注释。
mypy用于类型检查代码库，提交的代码不应产生类型错误。有关mypy的详细信息，请参见this page。- small修复可以通过创建pull请求提交。
- 非平凡的更改应该在提交必须引用的问题跟踪程序中有一个关联的issue（通常通过在提交消息的末尾添加
#refs <issue-id>）。 - 请为您所做的更改（如果适用）编写tests。
如果您对项目的贡献有任何疑问，请联系项目业主。
如contribution guidelines中所述，项目是使用mypy进行类型检查的，因此，首先，项目必须通过mypy的静态代码分析。
该项目使用pytest进行测试。选择的测试布局是测试在应用程序代码之外，请参见this page以了解它在实践中的含义。
如果安装了pytest，则可以使用项目目录中的pytest test命令执行测试集。
如果还安装了pytest-cov，则可以通过从项目的根目录执行pytest test --cov markyp_highlightjs来生成测试覆盖率报告。
许可证-麻省理工学院
这个库是在mit license的条件下开源的。
欢迎加入QQ群-->： 979659372
