{
  "url": "https://unifast.dev/ko/docs/packages/node/excerpt/",
  "locale": "ko",
  "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\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"
    }
  ]
}