{
  "url": "https://unifast.dev/docs/packages/node/abbr/",
  "locale": "en",
  "title": "abbr()",
  "description": "Convert abbreviation definitions into <abbr> elements with title attributes.",
  "section": "packages",
  "body": "```ts\nimport { abbr } from \"@unifast/node\";\n```\n\n## Signature\n\n```ts\nfunction abbr(): UnifastPlugin\n```\n\n## Parameters\n\nNone.\n\n## Usage\n\n```ts\nimport { compile, abbr } from \"@unifast/node\";\n\nconst md = `*[HTML]: Hyper Text Markup Language\n\nThe HTML specification is maintained by the W3C.`;\n\nconst result = compile(md, {\n  plugins: [abbr()],\n});\n// Occurrences of \"HTML\" are wrapped in <abbr title=\"Hyper Text Markup Language\">\n```\n\n## Examples\n\n### Basic abbreviation\n\nDefine an abbreviation with the `*[TERM]: Definition` syntax. The definition paragraph is removed from the output, and all occurrences of the term are wrapped in `<abbr>` elements:\n\n```ts\nimport { compile, abbr } from \"@unifast/node\";\n\nconst md = `*[HTML]: Hyper Text Markup Language\n\nHTML is the standard markup language for web pages.`;\n\nconst result = compile(md, { plugins: [abbr()] });\nconsole.log(result.output);\n// <p><abbr title=\"Hyper Text Markup Language\">HTML</abbr> is the standard markup language for web pages.</p>\n```\n\n### Multiple abbreviations\n\nYou can define multiple abbreviations. Each term is replaced independently throughout the document:\n\n```ts\nimport { compile, abbr } from \"@unifast/node\";\n\nconst md = `*[HTML]: Hyper Text Markup Language\n*[CSS]: Cascading Style Sheets\n\nHTML and CSS are the foundations of the web.`;\n\nconst result = compile(md, { plugins: [abbr()] });\nconsole.log(result.output);\n// <p><abbr title=\"Hyper Text Markup Language\">HTML</abbr> and <abbr title=\"Cascading Style Sheets\">CSS</abbr> are the foundations of the web.</p>\n```",
  "alternates": [
    {
      "locale": "en",
      "url": "https://unifast.dev/docs/packages/node/abbr/",
      "api": "https://unifast.dev//api/docs/packages/node/abbr.json"
    },
    {
      "locale": "ja",
      "url": "https://unifast.dev/ja/docs/packages/node/abbr/",
      "api": "https://unifast.dev//api/ja/docs/packages/node/abbr.json"
    },
    {
      "locale": "zh-CN",
      "url": "https://unifast.dev/zh-CN/docs/packages/node/abbr/",
      "api": "https://unifast.dev//api/zh-CN/docs/packages/node/abbr.json"
    },
    {
      "locale": "zh-TW",
      "url": "https://unifast.dev/zh-TW/docs/packages/node/abbr/",
      "api": "https://unifast.dev//api/zh-TW/docs/packages/node/abbr.json"
    },
    {
      "locale": "ko",
      "url": "https://unifast.dev/ko/docs/packages/node/abbr/",
      "api": "https://unifast.dev//api/ko/docs/packages/node/abbr.json"
    },
    {
      "locale": "fr",
      "url": "https://unifast.dev/fr/docs/packages/node/abbr/",
      "api": "https://unifast.dev//api/fr/docs/packages/node/abbr.json"
    },
    {
      "locale": "it",
      "url": "https://unifast.dev/it/docs/packages/node/abbr/",
      "api": "https://unifast.dev//api/it/docs/packages/node/abbr.json"
    },
    {
      "locale": "es",
      "url": "https://unifast.dev/es/docs/packages/node/abbr/",
      "api": "https://unifast.dev//api/es/docs/packages/node/abbr.json"
    },
    {
      "locale": "pt-BR",
      "url": "https://unifast.dev/pt-BR/docs/packages/node/abbr/",
      "api": "https://unifast.dev//api/pt-BR/docs/packages/node/abbr.json"
    },
    {
      "locale": "de",
      "url": "https://unifast.dev/de/docs/packages/node/abbr/",
      "api": "https://unifast.dev//api/de/docs/packages/node/abbr.json"
    },
    {
      "locale": "ru",
      "url": "https://unifast.dev/ru/docs/packages/node/abbr/",
      "api": "https://unifast.dev//api/ru/docs/packages/node/abbr.json"
    },
    {
      "locale": "hi",
      "url": "https://unifast.dev/hi/docs/packages/node/abbr/",
      "api": "https://unifast.dev//api/hi/docs/packages/node/abbr.json"
    },
    {
      "locale": "id",
      "url": "https://unifast.dev/id/docs/packages/node/abbr/",
      "api": "https://unifast.dev//api/id/docs/packages/node/abbr.json"
    },
    {
      "locale": "tr",
      "url": "https://unifast.dev/tr/docs/packages/node/abbr/",
      "api": "https://unifast.dev//api/tr/docs/packages/node/abbr.json"
    },
    {
      "locale": "vi",
      "url": "https://unifast.dev/vi/docs/packages/node/abbr/",
      "api": "https://unifast.dev//api/vi/docs/packages/node/abbr.json"
    }
  ]
}