{
  "url": "https://unifast.dev/zh-CN/docs/packages/node/excerpt/",
  "locale": "zh-CN",
  "title": "excerpt()",
  "description": "从文档内容中提取摘要。",
  "section": "packages",
  "body": "```ts\nimport { excerpt } from \"@unifast/node\";\n```\n\n## 签名\n\n```ts\nfunction excerpt(options?: ExcerptPluginOptions): UnifastPlugin\n```\n\n## 参数\n\n### options?\n\n摘要提取的配置\n\n| 属性 | 类型 | 默认值 | 描述 |\n|----------|------|---------|-------------|\n| `separator` | `string` | `\"<!-- more -->\"` | 用于分隔摘要和正文的注释标记 |\n| `fallbackParagraphs` | `number` | `1` | 在没有找到分隔符时，作为摘要的开头段落数量 |\n| `fallbackCharacters` | `number` | `undefined` | 回退摘要的最大字符长度（在单词边界截断） |\n\n当 `fallbackParagraphs` 和 `fallbackCharacters` 同时设置时，以 `fallbackParagraphs` 为准。\n\n## 返回值\n\n该插件会在编译结果中添加 `excerpt` 属性：\n\n| 属性 | 类型 | 描述 |\n|----------|------|-------------|\n| `result.excerpt` | `string \\| undefined` | 从文档中提取出的纯文本摘要 |\n\n## 用法\n\n```ts\nimport { compile, excerpt } from \"@unifast/node\";\n\nconst md = `\nThis is the introduction to my blog post.\n\n<!-- more -->\n\nThe rest of the article continues here with more details.\n`;\n\nconst result = compile(md, {\n  plugins: [excerpt()],\n});\n\nconsole.log(result.excerpt);\n// \"This is the introduction to my blog post.\"\n```\n\n## 示例\n\n### 使用分隔标记\n\n在 Markdown 中放置 `<!-- more -->` 注释，即可显式地标记摘要的结束位置：\n\n```ts\nimport { compile, excerpt } from \"@unifast/node\";\n\nconst md = `\n# My Blog Post\n\nThis is a **bold** introduction with some content.\n\nHere is a second paragraph still in the excerpt.\n\n<!-- more -->\n\nThis content is not included in the excerpt.\n`;\n\nconst result = compile(md, {\n  plugins: [excerpt()],\n});\n\nconsole.log(result.excerpt);\n// \"My Blog Post This is a bold introduction with some content. Here is a second paragraph still in the excerpt.\"\n```\n\n### 回退到前几段\n\n当未找到分隔标记时，该插件会回退为提取前 N 段：\n\n```ts\nimport { compile, excerpt } from \"@unifast/node\";\n\nconst md = `\n# My Blog Post\n\nThis is the first paragraph of my article.\n\nThis is the second paragraph with more details.\n\nThis is the third paragraph.\n`;\n\nconst result = compile(md, {\n  plugins: [\n    excerpt({\n      fallbackParagraphs: 2,\n    }),\n  ],\n});\n\nconsole.log(result.excerpt);\n// \"This is the first paragraph of my article. This is the second paragraph with more details.\"\n```\n\n### 回退到字符数限制\n\n将摘要截断到指定的最大字符数，并在单词边界处断开：\n\n```ts\nimport { compile, excerpt } from \"@unifast/node\";\n\nconst md = `\nThis is a long article that goes on and on with lots of content.\n`;\n\nconst result = compile(md, {\n  plugins: [\n    excerpt({\n      fallbackCharacters: 30,\n    }),\n  ],\n});\n\nconsole.log(result.excerpt);\n// \"This is a long article that\"\n```",
  "alternates": [
    {
      "locale": "en",
      "url": "https://unifast.dev/docs/packages/node/excerpt/",
      "api": "https://unifast.dev//api/docs/packages/node/excerpt.json"
    },
    {
      "locale": "ja",
      "url": "https://unifast.dev/ja/docs/packages/node/excerpt/",
      "api": "https://unifast.dev//api/ja/docs/packages/node/excerpt.json"
    },
    {
      "locale": "zh-CN",
      "url": "https://unifast.dev/zh-CN/docs/packages/node/excerpt/",
      "api": "https://unifast.dev//api/zh-CN/docs/packages/node/excerpt.json"
    },
    {
      "locale": "zh-TW",
      "url": "https://unifast.dev/zh-TW/docs/packages/node/excerpt/",
      "api": "https://unifast.dev//api/zh-TW/docs/packages/node/excerpt.json"
    },
    {
      "locale": "ko",
      "url": "https://unifast.dev/ko/docs/packages/node/excerpt/",
      "api": "https://unifast.dev//api/ko/docs/packages/node/excerpt.json"
    },
    {
      "locale": "fr",
      "url": "https://unifast.dev/fr/docs/packages/node/excerpt/",
      "api": "https://unifast.dev//api/fr/docs/packages/node/excerpt.json"
    },
    {
      "locale": "it",
      "url": "https://unifast.dev/it/docs/packages/node/excerpt/",
      "api": "https://unifast.dev//api/it/docs/packages/node/excerpt.json"
    },
    {
      "locale": "es",
      "url": "https://unifast.dev/es/docs/packages/node/excerpt/",
      "api": "https://unifast.dev//api/es/docs/packages/node/excerpt.json"
    },
    {
      "locale": "pt-BR",
      "url": "https://unifast.dev/pt-BR/docs/packages/node/excerpt/",
      "api": "https://unifast.dev//api/pt-BR/docs/packages/node/excerpt.json"
    },
    {
      "locale": "de",
      "url": "https://unifast.dev/de/docs/packages/node/excerpt/",
      "api": "https://unifast.dev//api/de/docs/packages/node/excerpt.json"
    },
    {
      "locale": "ru",
      "url": "https://unifast.dev/ru/docs/packages/node/excerpt/",
      "api": "https://unifast.dev//api/ru/docs/packages/node/excerpt.json"
    },
    {
      "locale": "hi",
      "url": "https://unifast.dev/hi/docs/packages/node/excerpt/",
      "api": "https://unifast.dev//api/hi/docs/packages/node/excerpt.json"
    },
    {
      "locale": "id",
      "url": "https://unifast.dev/id/docs/packages/node/excerpt/",
      "api": "https://unifast.dev//api/id/docs/packages/node/excerpt.json"
    },
    {
      "locale": "tr",
      "url": "https://unifast.dev/tr/docs/packages/node/excerpt/",
      "api": "https://unifast.dev//api/tr/docs/packages/node/excerpt.json"
    },
    {
      "locale": "vi",
      "url": "https://unifast.dev/vi/docs/packages/node/excerpt/",
      "api": "https://unifast.dev//api/vi/docs/packages/node/excerpt.json"
    }
  ]
}