@ github- docs/ 前题
解析并验证 YAML 前题
这是一个前题解析器建在 gray-matter 用于支持可选前题验证 重新验证器 JSON计划.
安装
npm install @github-docs/frontmatter
特征
- 使前题条目成为需要的或可选的
- 验证值类型,长度,图案等. 见 重新验证器# schema。 。 。 .
- 验证urls,电子邮件,IP地址,日期,时间等. 见 重新验证器#格式。 。 。 .
- 设置一个明确的允许值列表
enum。 。 。 . - 使用
validateKeyOrder - 计划未指定的否定值
validateKeyNames
使用量
const frontmatter = require('@github-docs/frontmatter')
const schema = {
properties: {
title: {
type: 'string',
required: true
},
meaning_of_life: {
type: 'number',
minimum: 40,
maximum: 50
}
}
}
const markdown = `---
title: Hello, World
meaning_of_life: 42
---
I am content.
`
const { data, content, errors } = frontmatter(markdown)
API 密码
frontmatter(markdown, [options])
解析包含标记下和(可选)前题的字符串.
markdown字符串( 需要) - 包含 YAML 前题的标记下文件的内容 .options对象( 可选)schema对象 - A 重新验证器 JSON计划.filepath字符串 - 正在解析的文件名称 。 用于错误发生时调试 .validateKeyNames布尔 - 如果true,检查所有密钥都指定为计划属性。 默认为falsevalidateKeyOrder布尔 - 如果true,检查所有密钥的顺序与他们在计划中出现的顺序相同。 默认为false
frontmatter.stringify(markdown, [data], [opts])
这是相同的 stringify 导出的方法 gray-matter 模块,可用于将标记下字符串和前题对象作为单一字符串一起加入.
file字符串对象 - 附加到字符串前事的内容字符串,或带有文件的文件对象. 内容字符串.data对象 - 要字符串的前题 .options对象 - 传递到灰色物质和js- yaml 的选项 .returns字符串 - 返回通过用分隔符将字符串所创建的字符串包裹起来,并将它附加到给定字符串中.
许可证
麻省理工学院