{
  "url": "https://unifast.dev/ja/docs/packages/node/excerpt/",
  "locale": "ja",
  "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プラグインは compile の結果に `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\nMarkdown に `<!-- 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"
    }
  ]
}