Hello world
\"\n);\n\n// result.text → \"Hello world\"\n// result.entities → [bold offset=0 len=5, italic offset=6 len=5]\n```\n\n### Supported HTML elements\n\n| Element | Result | Notes |\n|---|---|---|\n| ``, `` | bold | |\n| ``, `` | italic | |\n| `` | underline | |\n| `` | inline code | When not inside `` |\n| `` | pre block | Language extracted from `language-*` class |\n| `` | blockquote | Children processed recursively |\n| `` | link | |\n| `` … `` | bold | |\n| `
`, `
` | transparent wrapper | Children joined with `\"\"` |\n| `
` | `\\n` | |\n| `` | unordered list | Items prefixed with `- ` |\n| `` | ordered list | Items numbered from `start` |\n\nBlock-level elements at the root are separated by `\\n\\n`. List items are separated by `\\n`. Nested lists are supported and indented with `\\n` before the sub-list.\n\n### TipTap example\n\n```ts\nimport { htmlToFormattable } from \"@gramio/format/html\";\n\nconst html = `\nRelease notes
\nVersion 2.0 is out with exciting changes:
\n\n New htmlToFormattable function
Performance improvements
\nRead the full docs.
\n`;\n\nconst result = htmlToFormattable(html);\n// Sends correctly formatted message to Telegram with all entities intact\n```\n\n---\n\n## Using with Telegram Bot API\n\nThe `FormattableString` object has `.text` and `.entities` properties that map directly to Telegram's `sendMessage` parameters:\n\n```ts\nimport { format, bold, link } from \"@gramio/format\";\n\nconst msg = format`Check out ${bold(link(\"GramIO\", \"https://gramio.dev\"))}!`;\n\nawait bot.api.sendMessage({\n chat_id: chatId,\n text: msg.text,\n entities: msg.entities,\n});\n```\n\nWith [GramIO](https://gramio.dev/) you can pass the `FormattableString` directly:\n\n```ts\nbot.on(\"message\", (ctx) => {\n ctx.send(format`Hello ${bold(ctx.from.first_name)}!`);\n});\n```\n\n---\n\n## Rich messages and native tables\n\nFor Telegram Rich Messages, use the structured `table()` helper when you want a native\n`InputRichBlockTable` instead of Markdown text:\n\n```ts\nimport { blocks, table } from \"@gramio/format/rich\";\n\nconst report = blocks([\n blocks.heading(1, \"Release report\"),\n table(\n [[\"Package\", \"Version\"], [\"gramio\", \"0.14.0\"]],\n { bordered: true, striped: true, compact: true, align: [\"left\", \"right\"] },\n ),\n]);\n\nctx.send(report);\n```\n\n`table()` can also be sent directly. The first row is a header by default, and cell alignment\ndefaults to `left`/`top`. Use `blocks.cell(\"Total\", { colSpan: 2 })` for spans. The previous\nMarkdown/GFM serializer is available as `markdownTable()` for explicit Markdown composition with\n`rich([...])`.\n\nThis is a breaking change from `@gramio/format` 0.11: `table()` used to produce Markdown/GFM.\nRename existing Markdown calls to `markdownTable()` when upgrading to 0.12.\n\nFor a complete Markdown/HTML string produced by your own trusted serializer, use `rawRich()`;\nit preserves the syntax that the safe `rich\\`…\\`` tag escapes. Never pass untrusted text to\n`rawRich()`.\n\nWhen using `rowSpan`, omit the covered cells in following rows; column alignment follows the\nlogical table grid.\n\n---\n\n## See also\n\n- [Full documentation](https://gramio.dev/formatting.html)\n- [GramIO framework](https://gramio.dev/)\n- [Telegram MessageEntity docs](https://core.telegram.org/bots/api#messageentity)\n","readmeFilename":"README.md"}