基于markyp的html元素实现。
markyp-html的Python项目详细描述
markyp html
markyp基于html的实现。
安装
该项目列在python包索引中,只需执行pip install markyp-html
即可安装。
开始
如果您不熟悉markyp
的基本概念,请首先查看它的文档here。
下面这个非常简短的例子创建了最基本的hello world网页。如您所见,它只需要一个webpage()
调用和字符串转换。
frommarkyp_htmlimportwebpagepage=webpage("Hello World!",page_title="Hello World")# Get the actual HTML markup.html=str(page)# or page.markupprint(html)
下面是一个稍微复杂一点的hello world示例,它包含各种元数据、一些css和一些简单的文本元素:
frommarkyp_htmlimportmeta,style,webpagefrommarkyp_html.textimporth1,pfrommarkyp_html.inlineimportstrongpage=webpage(h1("markyp-html"),strong(p("Hello World!")),p("This page was generated using Python and markyp-html."),page_title="markyp-html demo page",head_elements=[style("h1 {color:red;}\np {color:blue;}")],metadata=[meta.author("Website Author"),meta.charset("UTF-8"),meta.description("markyp-html demo"),meta.keywords("markyp-html,markup,Python,HTML"),meta.viewport("width=device-width, initial-scale=1.0")])# Get the actual HTML markup.html=str(page)# or page.markupprint(html)
markyp-html
扩展
markyp-html
构建在markyp之上。一般来说,扩展遵循markyp-{domain-or-extension-name}
命名约定。
下面是构建在markyp-html
:
markyp-highlightjs
:在https://github.com/volfpeter/markyp-highlightjs使用highlight.js
在html中突出显示代码,欢迎贡献。markyp-bootstrap4
:在https://github.com/volfpeter/markyp-bootstrap4启动4实现,欢迎贡献。
如果您已经创建了一个开源的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_html
来生成测试覆盖率报告。
许可证-麻省理工学院
这个库是在mitlicense的条件下开源的。