{
  "url": "https://unifast.dev/zh-CN/docs/packages/node/frontmatter/",
  "locale": "zh-CN",
  "title": "frontmatter()",
  "description": "创建 frontmatter 插件，用于解析位于 Markdown/MDX 文档顶部的 YAML、TOML 或 JSON 元数据块。",
  "section": "packages",
  "body": "```ts\n\n```\n\n## 签名\n\n```ts\nfunction frontmatter(options?: FrontmatterPluginOptions): UnifastPlugin\n```\n\n## 参数\n\n### options?\n\nFrontmatter 格式的配置\n\n| 属性 | 类型 | 默认值 | 描述 |\n|----------|------|---------|-------------|\n| `yaml` | `boolean` | `true` | 启用 YAML frontmatter（使用 --- 作为分隔符） |\n| `toml` | `boolean` | `false` | 启用 TOML frontmatter（使用 +++ 作为分隔符） |\n| `json` | `boolean` | `false` | 启用 JSON frontmatter（使用 ;;; 作为分隔符） |\n\n## 用法\n\n```ts\n\nconst result = compile(md, {\n  plugins: [\n    frontmatter({\n      yaml: true,\n      toml: true,\n      json: true,\n    }),\n  ],\n});\n\nconsole.log(result.frontmatter);\n// { title: \"My Page\", date: \"2024-01-01\", tags: [\"markdown\", \"docs\"] }\n```\n\n## 示例\n\n### YAML Frontmatter\n\n```ts\n\nconst md = `---\ntitle: My Page\ndate: 2024-01-01\ntags:\n  - markdown\n  - docs\n---\n\n# Hello`;\n\nconst result = compile(md, { plugins: [frontmatter()] });\n\nconsole.log(result.frontmatter);\n// { title: \"My Page\", date: \"2024-01-01\", tags: [\"markdown\", \"docs\"] }\n```\n\n### TOML Frontmatter\n\n```ts\n\nconst md = `+++\ntitle = \"My Page\"\ndate = 2024-01-01\n+++\n\n# Hello`;\n\nconst result = compile(md, { plugins: [frontmatter({ toml: true })] });\n\nconsole.log(result.frontmatter);\n// { title: \"My Page\", date: \"2024-01-01\" }\n```\n\n### JSON Frontmatter\n\n```ts\n\nconst md = `;;;\n{\"title\": \"My Page\", \"draft\": false}\n;;;\n\n# Hello`;\n\nconst result = compile(md, { plugins: [frontmatter({ json: true })] });\n\nconsole.log(result.frontmatter);\n// { title: \"My Page\", draft: false }\n```",
  "alternates": [
    {
      "locale": "en",
      "url": "https://unifast.dev/docs/packages/node/frontmatter/",
      "api": "https://unifast.dev//api/docs/packages/node/frontmatter.json"
    },
    {
      "locale": "ja",
      "url": "https://unifast.dev/ja/docs/packages/node/frontmatter/",
      "api": "https://unifast.dev//api/ja/docs/packages/node/frontmatter.json"
    },
    {
      "locale": "zh-CN",
      "url": "https://unifast.dev/zh-CN/docs/packages/node/frontmatter/",
      "api": "https://unifast.dev//api/zh-CN/docs/packages/node/frontmatter.json"
    },
    {
      "locale": "zh-TW",
      "url": "https://unifast.dev/zh-TW/docs/packages/node/frontmatter/",
      "api": "https://unifast.dev//api/zh-TW/docs/packages/node/frontmatter.json"
    },
    {
      "locale": "ko",
      "url": "https://unifast.dev/ko/docs/packages/node/frontmatter/",
      "api": "https://unifast.dev//api/ko/docs/packages/node/frontmatter.json"
    },
    {
      "locale": "fr",
      "url": "https://unifast.dev/fr/docs/packages/node/frontmatter/",
      "api": "https://unifast.dev//api/fr/docs/packages/node/frontmatter.json"
    },
    {
      "locale": "it",
      "url": "https://unifast.dev/it/docs/packages/node/frontmatter/",
      "api": "https://unifast.dev//api/it/docs/packages/node/frontmatter.json"
    },
    {
      "locale": "es",
      "url": "https://unifast.dev/es/docs/packages/node/frontmatter/",
      "api": "https://unifast.dev//api/es/docs/packages/node/frontmatter.json"
    },
    {
      "locale": "pt-BR",
      "url": "https://unifast.dev/pt-BR/docs/packages/node/frontmatter/",
      "api": "https://unifast.dev//api/pt-BR/docs/packages/node/frontmatter.json"
    },
    {
      "locale": "de",
      "url": "https://unifast.dev/de/docs/packages/node/frontmatter/",
      "api": "https://unifast.dev//api/de/docs/packages/node/frontmatter.json"
    },
    {
      "locale": "ru",
      "url": "https://unifast.dev/ru/docs/packages/node/frontmatter/",
      "api": "https://unifast.dev//api/ru/docs/packages/node/frontmatter.json"
    },
    {
      "locale": "hi",
      "url": "https://unifast.dev/hi/docs/packages/node/frontmatter/",
      "api": "https://unifast.dev//api/hi/docs/packages/node/frontmatter.json"
    },
    {
      "locale": "id",
      "url": "https://unifast.dev/id/docs/packages/node/frontmatter/",
      "api": "https://unifast.dev//api/id/docs/packages/node/frontmatter.json"
    },
    {
      "locale": "tr",
      "url": "https://unifast.dev/tr/docs/packages/node/frontmatter/",
      "api": "https://unifast.dev//api/tr/docs/packages/node/frontmatter.json"
    },
    {
      "locale": "vi",
      "url": "https://unifast.dev/vi/docs/packages/node/frontmatter/",
      "api": "https://unifast.dev//api/vi/docs/packages/node/frontmatter.json"
    }
  ]
}