{
  "url": "https://unifast.dev/pt-BR/docs/packages/node/overview/",
  "locale": "pt-BR",
  "title": "@unifast/node",
  "description": "Binding Node.js para o compilador Markdown/MDX do unifast, alimentado por Rust nativo",
  "section": "packages",
  "body": "## Visão Geral\n\nO `@unifast/node` é o ponto de entrada principal para usar o unifast no Node.js. Ele fornece a função [`compile()`](/docs/packages/node/compile) que invoca o compilador Rust nativo via napi-rs para máxima performance. Também suporta o sistema de plugins, permitindo que transformações HAST sejam aplicadas em JavaScript após a etapa de compilação em Rust.\n\n## Instalação\n\n> O addon Rust nativo precisa estar pré-construído. Execute `cargo build -p unifast-bindings-node --release` se o binário nativo não estiver disponível.\n\n## Início Rápido\n\n```ts\n\nconst result = compile(\"# Hello, **world**!\");\nconsole.log(result.output);\n// <h1 id=\"hello-world\">Hello, <strong>world</strong>!</h1>\n```\n\n## Pipeline de Plugins\n\nQuando plugins são fornecidos, `compile()` executa a seguinte pipeline:\n\n1. **Extrair plugins** - Separa `plugins` do restante das opções\n2. **Mesclar opções** - Faz deep-merge das `options` de cada plugin nas opções de compilação\n3. **Forçar HAST** - Se algum plugin tem um `hastTransform`, a chamada nativa usa `outputKind: \"hast\"`\n4. **Compilação nativa** - Chama o compilador Rust via napi-rs\n5. **Transformações HAST** - Aplica o `hastTransform` de cada plugin em ordem\n6. **Converter saída** - Se o usuário não solicitou saída HAST, converte de volta para HTML via `hastToHtml`\n\n## Plugins Integrados\n\nAs seguintes funções factory de plugins estão incluídas — sem necessidade de instalação separada:\n\n`gfm`, `frontmatter`, `sanitize`, `syntect`, `treeSitter`, `toc`, `externalLinks`, `autolinkHeadings`, `smartypants`, `wikiLink`, `codeImport`, `emoji`, `breaks`, `math`, `githubAlert`, `sectionize`, `directive`, `definitionList`, `rubyAnnotation`, `cjk`\n\n```ts\n\nconst result = compile(source, {\n  plugins: [gfm(), frontmatter(), syntect()],\n});\n```\n\n## Resumo de Exports\n\n| Export | Tipo | Descrição |\n|--------|------|-------------|\n| `compile` | function | Compila Markdown/MDX para HTML ou outros formatos |\n| `gfm`, `frontmatter`, ... | function | Factories de plugins integrados (20 no total) |\n| `hastToHtml` | function | Serializador de HAST para HTML (re-exportado de `@unifast/core`) |\n| `CompileOptions` | type | Configuração de compilação |\n| `CompileResult` | type | Resultado da compilação |\n| `UnifastPlugin` | type | Interface de plugin |\n| `TocEntry` | type | Entrada da table of contents |\n| `HastRoot` | type | Nó raiz HAST |\n| `HastElement` | type | Nó de elemento HAST |\n| `HastText` | type | Nó de texto HAST |\n| `HastNode` | type | União de todos os tipos de nós HAST |\n| `UnifastError` | class | Classe base de erro |\n| `ParseError` | class | Classe de erro de parse |\n| `CompileError` | class | Classe de erro de compilação |",
  "alternates": [
    {
      "locale": "en",
      "url": "https://unifast.dev/docs/packages/node/overview/",
      "api": "https://unifast.dev//api/docs/packages/node/overview.json"
    },
    {
      "locale": "ja",
      "url": "https://unifast.dev/ja/docs/packages/node/overview/",
      "api": "https://unifast.dev//api/ja/docs/packages/node/overview.json"
    },
    {
      "locale": "zh-CN",
      "url": "https://unifast.dev/zh-CN/docs/packages/node/overview/",
      "api": "https://unifast.dev//api/zh-CN/docs/packages/node/overview.json"
    },
    {
      "locale": "zh-TW",
      "url": "https://unifast.dev/zh-TW/docs/packages/node/overview/",
      "api": "https://unifast.dev//api/zh-TW/docs/packages/node/overview.json"
    },
    {
      "locale": "ko",
      "url": "https://unifast.dev/ko/docs/packages/node/overview/",
      "api": "https://unifast.dev//api/ko/docs/packages/node/overview.json"
    },
    {
      "locale": "fr",
      "url": "https://unifast.dev/fr/docs/packages/node/overview/",
      "api": "https://unifast.dev//api/fr/docs/packages/node/overview.json"
    },
    {
      "locale": "it",
      "url": "https://unifast.dev/it/docs/packages/node/overview/",
      "api": "https://unifast.dev//api/it/docs/packages/node/overview.json"
    },
    {
      "locale": "es",
      "url": "https://unifast.dev/es/docs/packages/node/overview/",
      "api": "https://unifast.dev//api/es/docs/packages/node/overview.json"
    },
    {
      "locale": "pt-BR",
      "url": "https://unifast.dev/pt-BR/docs/packages/node/overview/",
      "api": "https://unifast.dev//api/pt-BR/docs/packages/node/overview.json"
    },
    {
      "locale": "de",
      "url": "https://unifast.dev/de/docs/packages/node/overview/",
      "api": "https://unifast.dev//api/de/docs/packages/node/overview.json"
    },
    {
      "locale": "ru",
      "url": "https://unifast.dev/ru/docs/packages/node/overview/",
      "api": "https://unifast.dev//api/ru/docs/packages/node/overview.json"
    },
    {
      "locale": "hi",
      "url": "https://unifast.dev/hi/docs/packages/node/overview/",
      "api": "https://unifast.dev//api/hi/docs/packages/node/overview.json"
    },
    {
      "locale": "id",
      "url": "https://unifast.dev/id/docs/packages/node/overview/",
      "api": "https://unifast.dev//api/id/docs/packages/node/overview.json"
    },
    {
      "locale": "tr",
      "url": "https://unifast.dev/tr/docs/packages/node/overview/",
      "api": "https://unifast.dev//api/tr/docs/packages/node/overview.json"
    },
    {
      "locale": "vi",
      "url": "https://unifast.dev/vi/docs/packages/node/overview/",
      "api": "https://unifast.dev//api/vi/docs/packages/node/overview.json"
    }
  ]
}