Paragraph 1
\n```\n\n#### Configuration\n\nBy default, `slateToHtml` incorporates transformation rules based on the example in [Deserializing | Serializing | Slate](https://docs.slatejs.org/concepts/10-serializing#deserializing).\n\n##### Payload CMS\n\nIf you are using [Payload CMS](https://payloadcms.com/), import the Payload configuration file and pass it as a parameter to the serializer.\n\n```ts\nimport { slateToHtml, payloadSlateToHtmlConfig } from '@slate-serializers/html'\n\nconst slate = [\n {\n children: [\n {\n text: 'Heading 1',\n },\n ],\n type: 'h1',\n },\n]\n\nconst serializedToHtml = slateToHtml(slate, payloadSlateToHtmlConfig)\n```\n\n##### Custom configuration\n\nYou can create your own configuration file that implements your schema. See [packages/dom/src/lib/config/payload.ts](https://github.com/thompsonsj/slate-serializers/blob/main/packages/dom/src/lib/config/payload.ts) for an example of how to extend the default configuration or copy [packages/dom/src/lib/config/default.ts](https://github.com/thompsonsj/slate-serializers/blob/main/packages/dom/src/lib/config/default.ts) and rewrite it as appropriate.\n\n| Option | Description | Default |\n| - | - | - |\n| `markMap` | Map Slate JSON properties to HTML formatting element tags. Accepts an array of HTML element tag names. | See [default config](https://github.com/thompsonsj/slate-serializers/blob/main/packages/dom/src/lib/config/default.ts). Example: `{ code: ['pre', 'code'], /* ... */ }` |\n| `elementMap` | Map Slate JSON `type` values to HTML element tags. Use `elementTransforms` for more control over the returned element. | See [default config](https://github.com/thompsonsj/slate-serializers/blob/main/packages/dom/src/lib/config/default.ts). Example: `{ paragraph: 'p', /* ... */ }` |\n| `markTransforms` | Define transform functions for Slate JSON properties. Overrides and corresponding values in `markMap`. Functions return a [`domhandler` `Element`](https://github.com/fb55/domhandler); use `import { Element } from '@slate-serializers/dom'`. | See [default config](https://github.com/thompsonsj/slate-serializers/blob/main/packages/dom/src/lib/config/default.ts). |\n| `elementTransforms` | Define transform functions for Slate JSON node types. Overrides and corresponding values in `elementMap`. | See [default config](https://github.com/thompsonsj/slate-serializers/blob/main/packages/dom/src/lib/config/default.ts). |\n| `encodeEntities` | See [cheeriojs/dom-serializer - encodeEntities](https://github.com/cheeriojs/dom-serializer#encodeentities) | `true` |\n| `alwaysEncodeBreakingEntities` | Encode `&`, `<` and `>` regardless of other option settings. | `false` |\n| `alwaysEncodeCodeEntities` | Encode entities in `` tags regardless of other option settings. | `true` |\n| `convertLineBreakToBr` | Convert `\\n` line breaks in Slate text nodes to an HTML `
` element. | `true` |\n\n\n### htmlToSlate\n\n```ts\nimport { htmlToSlate } from '@slate-serializers/html'\n\nconst html = `Heading 1
Paragraph 1
`\n\nconst serializedToSlate = htmlToSlate(html)\n// output\n/*\n[\n {\n children: [\n {\n text: 'Heading 1',\n },\n ],\n type: 'h1',\n },\n {\n children: [\n {\n text: 'Paragraph 1',\n },\n ],\n type: 'p',\n },\n]\n*/\n```\n\n#### Configuration\n\nBy default, `htmlToSlate` incorporates transformation rules based on the example in [HTML | Serializing | Slate](https://docs.slatejs.org/concepts/10-serializing#html).\n\n##### Payload CMS\n\nIf you are using [Payload CMS](https://payloadcms.com/), import the Payload configuration file and pass it as a parameter to the serializer.\n\n```ts\nimport { htmlToSlate, payloadHtmlToSlateConfig } from '@slate-serializers/html'\n\nconst html = `Heading 1
Paragraph 1
`\n\nconst serializedToSlate = htmlToSlate(html, payloadHtmlToSlateConfig)\n```\n\n#### Options\n\nCreate your own configuration file that implements your schema.\n\n- See [packages/html/src/lib/serializers/htmlToSlate/config/payload.ts](https://github.com/thompsonsj/slate-serializers/blob/main/packages/html/src/lib/serializers/htmlToSlate/config/payload.ts) for an example of how to extend the default configuration; or\n- copy [packages/html/src/lib/serializers/htmlToSlate/config/default.ts](https://github.com/thompsonsj/slate-serializers/blob/main/packages/html/src/lib/serializers/htmlToSlate/config/default.ts) and rewrite it as appropriate.\n\nFor more detailed documentation and examples, see [htmlToSlate | `slate-serializers`](https://thompsonsj.github.io/slate-serializers-demo/html-to-slate/docs).\n\n| Option | Description | Default |\n| - | - | - |\n| `textTags` | Define transform functions for HTML formatting elements. | See [default config](https://github.com/thompsonsj/slate-serializers/blob/main/packages/html/src/lib/serializers/htmlToSlate/config/default.ts). Examples: [textTags.spec.ts](https://github.com/thompsonsj/slate-serializers/blob/main/packages/html/src/lib/tests/htmlToSlate/configuration/textTags.spec.ts). |\n| `elementTags` | Define transform functions for HTML element tag names. | See [default config](https://github.com/thompsonsj/slate-serializers/blob/main/packages/html/src/lib/serializers/htmlToSlate/config/default.ts). Example `{ p: () => ({ type: 'p' }), /* ... */ }`. |\n| `htmlPreProcessString` | Perform operations on the HTML string before serialization. | See [default config](https://github.com/thompsonsj/slate-serializers/blob/main/packages/html/src/lib/serializers/htmlToSlate/config/default.ts) (replaces `` with `` for parsing). |\n| `filterWhitespaceNodes` | Remove whitespace that does not contribute meaning. | `true` |\n| `convertBrToLineBreak` | Convert br tags to line breaks in Slate. | `true` |\n| `brStrategy` | How converted `
` tags are represented: `block` (default, historical empty-block / context `\\n` behavior) or `newline` (always `\\n`, coalesce plain text, collapse breaks before a following block). | `'block'` |\n\n## See also\n\n- [Repository config docs](https://github.com/thompsonsj/slate-serializers/tree/main/docs/config) โ Markdown companions to the tables above.\n- [SlateToReact](https://www.npmjs.com/package/@slate-serializers/react) โ React output with the same option keys as `slateToHtml`; see [flat config](https://github.com/thompsonsj/slate-serializers/blob/main/docs/config/slateToReact.md).\n","readmeFilename":"README.md"}