{
  "url": "https://unifast.dev/fr/docs/packages/node/excerpt/",
  "locale": "fr",
  "title": "excerpt()",
  "description": "Extrait un extrait depuis le contenu du document.",
  "section": "packages",
  "body": "```ts\nimport { excerpt } from \"@unifast/node\";\n```\n\n## Signature\n\n```ts\nfunction excerpt(options?: ExcerptPluginOptions): UnifastPlugin\n```\n\n## Paramètres\n\n### options?\n\nConfiguration de l'extraction d'extrait\n\n| Propriété | Type | Défaut | Description |\n|----------|------|---------|-------------|\n| `separator` | `string` | `\"<!-- more -->\"` | Marqueur de commentaire qui sépare l'extrait du reste |\n| `fallbackParagraphs` | `number` | `1` | Nombre de paragraphes de tête à utiliser comme extrait lorsqu'aucun séparateur n'est trouvé |\n| `fallbackCharacters` | `number` | `undefined` | Longueur maximale en caractères pour l'extrait de repli (tronqué sur une limite de mot) |\n\nLorsque `fallbackParagraphs` et `fallbackCharacters` sont tous deux définis, `fallbackParagraphs` prévaut.\n\n## Valeur de retour\n\nLe plugin ajoute une propriété `excerpt` au résultat de compilation :\n\n| Propriété | Type | Description |\n|----------|------|-------------|\n| `result.excerpt` | `string \\| undefined` | Extrait en texte brut issu du document |\n\n## Utilisation\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## Exemples\n\n### Avec un marqueur de séparation\n\nPlacez un commentaire `<!-- more -->` dans votre Markdown pour indiquer explicitement la fin de l'extrait :\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### Repli sur le premier paragraphe\n\nLorsqu'aucun marqueur de séparation n'est trouvé, le plugin se rabat sur l'extraction des N premiers paragraphes :\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### Repli sur une limite de caractères\n\nTronquez l'extrait à une longueur maximale de caractères, en coupant sur une limite de mot :\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"
    }
  ]
}