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\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, payloadSlateToDomConfig } from 'slate-serializers'\n\nconst slate = [\n {\n children: [\n {\n text: 'Heading 1',\n },\n ],\n type: 'h1',\n },\n]\n\nconst serializedToHtml = slateToHtml(slate, payloadSlateToDomConfig)\n```\n\nYou can create your own configuration file that implements your schema. See [src/config/slateToDom/payload.ts](src/config/slateToDom/payload.ts) for an example of how to extend the default configuration or copy [src/config/slateToDom/default.ts](src/config/slateToDom/default.ts) and rewrite it as appropriate.\n\n### htmlToSlate\n\n```ts\nimport { htmlToSlate } from 'slate-serializers'\n\nconst html = `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\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'\n\nconst html = `Paragraph 1
`\n\nconst serializedToSlate = htmlToSlate(html, payloadHtmlToSlateConfig)\n```\n\nYou can create your own configuration file that implements your schema. See [src/config/htmlToSlate/payload.ts](src/config/htmlToSlate/payload.ts) for an example of how to extend the default configuration or copy [src/config/htmlToSlate/default.ts](src/config/htmlToSlate/default.ts) and rewrite it as appropriate.\n\nFor a breakdown of configuration options, see [docs/config/htmlToSlate.md](docs/config/htmlToSlate.md).\n\n#### Whitespace\n\n`htmlToSlate` processes whitespace in a similar way to browsers. It minifies whitespace while trying to preserve meaning. For details, see [docs/engineering.md#whitespace](docs/engineering.md#whitespace).\n\n### slateToDom\n\n`slateToHtml` is a simple wrapper that runs [`dom-serializer`](https://www.npmjs.com/package/dom-serializer) on the output from `slateToDom`.\n\n`slateToDom` is made available in case you wish to work with the DOM output yourself or run `dom-serializer` using any of the available options.\n\nIt accepts the same configuration object as [slateToHtml](#slatetohtml).\n\n### Commits\n\nTLDR: contributors can format commit messages in any way, maintainers should use conventional commits. \n\nThis repository uses [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/).\n\nConventional commits are not enforced. General guidance:\n\n- Commit messages can be formatted in any way on a pull request.\n- Conventional commit messages are preferred on pull request squash and merge.\n\nRun `npx cz` instead of `git commit` to lint commit messages using [@commitlint/cli](https://www.npmjs.com/package/@commitlint/cli). \n","readmeFilename":"README.md"}