@github-docs/frontmatter

中文文档
1.3.1发布于 2020/03/28MITCommonJS近 30 天下载 4112

解析并验证 YAML 前题

中文使用文档
文档目录7 节
  1. 安装
  2. 特征
  3. 使用量
  4. API 密码
  5. frontmatter(markdown, [options])
  6. frontmatter.stringify(markdown, [data], [opts])
  7. 许可证

@ github- docs/ 前题

解析并验证 YAML 前题

这是一个前题解析器建在 gray-matter 用于支持可选前题验证 重新验证器 JSON计划.

安装

这是一个 节点.js 模块 npm 登记。 。 。 .

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,检查所有密钥都指定为计划属性。 默认为 false
    • validateKeyOrder 布尔 - 如果 true,检查所有密钥的顺序与他们在计划中出现的顺序相同。 默认为 false

frontmatter.stringify(markdown, [data], [opts])

这是相同的 stringify 导出的方法 gray-matter 模块,可用于将标记下字符串和前题对象作为单一字符串一起加入.

  • file 字符串对象 - 附加到字符串前事的内容字符串,或带有文件的文件对象. 内容字符串.
  • data 对象 - 要字符串的前题 .
  • options 对象 - 传递到灰色物质和js- yaml 的选项 .
  • returns 字符串 - 返回通过用分隔符将字符串所创建的字符串包裹起来,并将它附加到给定字符串中.

许可证

麻省理工学院

版本与发布记录

@github-docs/frontmatter 共发布 6 个版本,首次发布于 2019/09/11;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.3.1latest2020/03/286 年前
1.3.02019/12/116 年前
1.2.12019/11/017 年前
1.2.02019/09/117 年前
1.1.02019/09/117 年前
1.0.02019/09/117 年前

关于 @github-docs/frontmatter 的常见问题

@github-docs/frontmatter 是什么?

解析并验证 YAML 前题

如何安装 @github-docs/frontmatter?

在项目目录运行 npm install @github-docs/frontmatter,或使用 pnpm add / yarn add / bun add。

@github-docs/frontmatter 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/github-docs__frontmatter 是否存在。

@github-docs/frontmatter 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@github-docs/frontmatter 可以商用吗?

@github-docs/frontmatter 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@github-docs/frontmatter 的下载量有多少?

根据 npm 官方下载统计,@github-docs/frontmatter 在 2026/10/17 – 2026/11/15 这 30 天内被下载 4,112 次,日均约 137 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@github-docs/frontmatter 还在维护吗?

最新版本 1.3.1 发布于 2020/03/28(6 年前);至今共发布 6 个版本,其中过去 12 个月发布了 0 个;首次发布于 2019/09/11。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。