README.md

slate-serializers

Docs/Demo: https://thompsonsj.github.io/slate-serializers-demo.

A collection of serializers to convert Slate JSON objects to various formats and vice versa. Designed to work in both Node.js and browser environments.

Convert Slate to DOM

• Convert Slate to a DOM object with slateToDom.
• Use the suite of DOM manipulation tools for htmlparser2 before serializing to HTML.
• NPM: https://www.npmjs.com/package/@slate-serializers/dom.

Convert Slate to HTML and vice versa

• Convert Slate to HTML and vice versa with htmlToSlate and slateToHtml.
• NPM: https://www.npmjs.com/package/@slate-serializers/html.

Include framework-agnostic components

• Include top-level custom components with slateToTemplate. Framework agnostic - e.g. return Astro, React or Vue components alongside regular HTML nodes.
• NPM: https://www.npmjs.com/package/@slate-serializers/template

Convert Slate to React

• Convert Slate to React with slateToReact.
• NPM: https://www.npmjs.com/package/@slate-serializers/react

More information

• For engineering decisions, see Engineering.
• Review generated NX documentation at NX.
• This repository is an NX monorepo. Review the docs at https://nx.dev/.
• Related repository: https://github.com/thompsonsj/slate-serializers-demo. Demo/docs site. Not included in this monorepo to replicate repositories that use these libraries more effectively.