一个用于解析/忽略frontmatter的mdformat插件。
项目描述
mdformat-frontmatter
一个mdformat插件，用于确保yaml front-matter被尊重。许多工具（如jekyll）使用yaml front matter进行自动化。 mdformat-frontmatter仅支持yaml。例如
---
test: yaml
---
# This looks okay
For some markdown code.
frontmatter只能位于代码的第一行或两行。
# This is not
---
test: yaml
---
注意：目前此插件还不够复杂。主要目标是允许正确形成的yaml头部块通过。错误形成的块可能导致奇怪的行为。
开发
此包是从executable books提供的模板构建的，并进行了自定义（特别是将内容PR与发布周期分开）。此包使用flit作为构建引擎，并使用tox进行测试自动化。
要安装这些开发依赖项
pip install tox
要运行测试
tox
以及测试覆盖率
tox -e py37-cov
编写测试的最简单方法是编辑tests/fixtures.md
要运行代码格式化和风格检查
tox -e py37-pre-commit
或直接
pip install pre-commit
pre-commit run --all
要运行预提交钩子测试
tox -e py37-hook
发布到PyPi
可以直接使用flit
pip install flit
flit publish
或者通过创建一个标签等于版本的发布来触发 GitHub Action 作业，例如 v0.0.1。
注意，这需要在 PyPi 上生成一个 API 密钥并将其添加到存储库 Settings/Secrets 下的 PYPI_KEY。
下载文件
下载适合您平台的文件。如果您不确定选择哪个，请了解有关 安装包 的更多信息。
源分布
mdformat_frontmatter-2.0.8.tar.gz (3.3 kB 查看哈希值)