{"_id":"@contentful/rich-text-html-renderer-demo","_rev":"319-216fb6d76ab2f073b3397b9b67b2ba6f","name":"@contentful/rich-text-html-renderer-demo","dist-tags":{"latest":"0.0.0-determined-by-semantic-release"},"versions":{"6.0.11111":{"name":"@contentful/rich-text-html-renderer-demo","version":"6.0.11111","license":"MIT","_id":"@contentful/rich-text-html-renderer-demo@6.0.11111","maintainers":[{"name":"axe312","email":"roetsch.beni@googlemail.com"},{"name":"cribbles","email":"csloop@wesleyan.edu"},{"name":"danwe","email":"daniel.a.r.werner@gmail.com"},{"name":"dominik.markusic","email":"dominik.markusic@contentful.com"},{"name":"eamodeorubio","email":"eamodeorubio@gmail.com"},{"name":"elblivion","email":"anthony+nonpmspam@contentful.com"},{"name":"ewakurekmqa","email":"ewa@contentful.com"},{"name":"farruco.sanjurjo","email":"farruco.sanjurjo@gmail.com"},{"name":"felipecoe","email":"felipe@contentful.com"},{"name":"guilebarbosa","email":"guipvb@gmail.com"},{"name":"hollensteiner","email":"claushollensteiner@gmail.com"},{"name":"it-internal","email":"it-internal@contentful.com"},{"name":"jakub-contentful","email":"jakub@contentful.com"},{"name":"johannes_bugiel","email":"johannes.bugiel@contentful.com"},{"name":"johanneswuerbach","email":"johannes.wuerbach@googlemail.com"},{"name":"joshuasmock","email":"f1144756@mvrht.com"},{"name":"jpawlyn","email":"jpawlyn@gmail.com"},{"name":"kgarbaya","email":"kgarbaya@gmail.com"},{"name":"lneves75","email":"luis.neves75@gmail.com"},{"name":"m10l","email":"mike.mitchell@contentful.com"},{"name":"marina-cf","email":"marina.guseva@contentful.com"},{"name":"markuslaut","email":"markus.lautenbach@contentful.com"},{"name":"martzoukos","email":"spiros@contentful.com"},{"name":"medturki","email":"mohamed@contentful.com"},{"name":"ohookins-ctf","email":"oliver@contentful.com"},{"name":"phbschmidt","email":"phoebe.schmidt@contentful.com"},{"name":"poberherr","email":"patrick.oberherr@gmail.com"},{"name":"roboben","email":"ben@contentful.com"},{"name":"ronaldronson","email":"ronald.ronson@outlook.com"},{"name":"sbezludny","email":"serg.bezludny@gmail.com"},{"name":"sey1000","email":"sey.cheon@contentful.com"},{"name":"silhoue","email":"joanna@contentful.com"},{"name":"stefanjudis","email":"stefanjudis@gmail.com"},{"name":"stupchiy","email":"sergiy@contentful.com"},{"name":"suevalov","email":"suevalov.work@gmail.com"},{"name":"thebesson","email":"tankidet@gmail.com"},{"name":"timbeyer","email":"tim.beyer@gmail.com"},{"name":"zcei","email":"stephanschndr@gmail.com"},{"name":"zeusdeux","email":"zeusdeux@gmail.com"}],"homepage":"https://github.com/contentful/rich-text#readme","bugs":{"url":"https://github.com/contentful/rich-text/issues"},"dist":{"shasum":"22284a59333ffca8005db8846dad8331f271c284","tarball":"https://registry.npmjs.org/@contentful/rich-text-html-renderer-demo/-/rich-text-html-renderer-demo-6.0.11111.tgz","fileCount":49,"integrity":"sha512-+a8VfUNyR17H7vYB2rP4SjebNFUcm1feBA/tVHleQAPEG75O6JfxW+P5acL/SMkdKrlYKTKQuC99Bgg/eUB4Tw==","signatures":[{"sig":"MEUCIQCtnMAOjcdAUw1h3MgQHuS7NrS5Z8DPQRkFso9GkNgOTgIgSdJrfPvo9m4gta9N6UZBftCXA7E0G/MWNrrEZ+FOCr4=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":68658,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJb0wkbCRA9TVsSAnZWagAAtkoP/RxZjoa9IySs6RKm3beu\nCX5bgwKipEazXewYl8AUH27ptplPoOPVzQ6WbSXPDauOuIuXUey7q892Nd5e\nbK0tVbMdbOnJcoGrYgvRPDu9+kOR0lM9ln09LtrhxupCdK9HwCF/eniMGuz8\nfoFFYDPvJ0Kd1DshYEAxU3q5IVoSJu3h7VpgnIzNb/kGciH9UQJv8NbBd6W+\nJ9EViujEtp7e5eZUw9XeQouju6zEykRvgwiFDF2QPTr67jzxfmdxWwWeXO8w\nAM5AJKlC02p9Gtt724NKz9nulZ4ZkYCdm/MI6Nf31S1i4y0PF4wk7Mtymvc0\nKqzPhyjTGC6/jCOO6kTijMYxZi0oNYMLl57qWvczaMD3GdZ/7uYo4LBDrhRy\nI1qXhfQ8M6u5TgneJLWXX5R1mkT7wpudAwOs+aE25oQ9+QqhS8gfWIIkv83e\nLj+7nyFnJ7rI5EKq0GoCD9bAKEaM+HPdbQ83P66E/60k8e5brmbc7J39uDrc\n3wbXIoPZwQrz8zmKnkxMKZXn+VBzS2YnTUU+IrZUCcmoiBx446XFJezjid1a\nOeSIL28jRcokfPbWISR5K0XWu6o16ych+bPL1eTMFH1CutrcwvNLwjlWhp/j\naAogUfYEN8gbPEpH162KoyqD3Vo0bDXYWtrht6PZ685cHmINYRxjSF6aM8WZ\nj3L1\r\n=qpL+\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/rich-text-html-renderer-demo.es5.js","engines":{"node":">=6.0.0"},"scripts":{"build":"tsc --module commonjs && rollup -c rollup.config.js","start":"tsc && rollup -c rollup.config.js -w","prebuild":"rimraf dist","report-coverage":"cat ./coverage/lcov.info | coveralls"},"typings":"dist/types/rich-text-html-renderer-demo.d.ts","_npmUser":{"name":"cribbles","email":"csloop@wesleyan.edu"},"repository":{"url":"git+https://github.com/contentful/rich-text.git","type":"git"},"_npmVersion":"6.4.1","description":"HTML renderer for the Rich Text document.","directories":{},"_nodeVersion":"8.11.1","dependencies":{"@semantic-release/git":"6.0.2","@semantic-release/npm":"3.4.1","semantic-release-monorepo":"^6.1.1","@semantic-release/changelog":"2.1.2","@contentful/rich-text-types-demo":"^6.0.11111"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^23.6.0","faker":"^4.1.0","husky":"^1.1.2","colors":"^1.1.2","git-cz":"^1.7.1","prompt":"^1.0.0","rimraf":"^2.6.2","rollup":"^0.66.6","tslint":"^5.11.0","ts-jest":"^23.10.4","ts-node":"^7.0.1","prettier":"^1.14.3","coveralls":"^3.0.2","cross-env":"^5.2.0","commitizen":"^3.0.4","typescript":"^2.6.2","@types/jest":"^22.0.0","@types/node":"^10.0.3","lint-staged":"^7.3.0","@types/faker":"^4.1.2","replace-in-file":"^3.4.2","lodash.camelcase":"^4.3.0","semantic-release":"15.6.3","@types/lodash.omit":"^4.5.3","rollup-plugin-json":"^3.1.0","travis-deploy-once":"^5.0.9","validate-commit-msg":"^2.14.0","@types/lodash.flatmap":"^4.5.3","rollup-plugin-commonjs":"^9.2.0","tslint-config-prettier":"^1.15.0","tslint-config-standard":"^8.0.1","rollup-plugin-sourcemaps":"^0.4.2","cz-conventional-changelog":"^2.1.0","rollup-plugin-typescript2":"^0.17.2","rollup-plugin-node-resolve":"^3.4.0"},"_npmOperationalInternal":{"tmp":"tmp/rich-text-html-renderer-demo_6.0.11111_1540557083047_0.12589643651926496","host":"s3://npm-registry-packages"}},"0.0.0-determined-by-semantic-release":{"name":"@contentful/rich-text-html-renderer-demo","version":"0.0.0-determined-by-semantic-release","license":"MIT","_id":"@contentful/rich-text-html-renderer-demo@0.0.0-determined-by-semantic-release","maintainers":[{"name":"axe312","email":"roetsch.beni@googlemail.com"},{"name":"cribbles","email":"csloop@wesleyan.edu"},{"name":"danwe","email":"daniel.a.r.werner@gmail.com"},{"name":"dominik.markusic","email":"dominik.markusic@contentful.com"},{"name":"eamodeorubio","email":"eamodeorubio@gmail.com"},{"name":"elblivion","email":"anthony+nonpmspam@contentful.com"},{"name":"ewakurekmqa","email":"ewa@contentful.com"},{"name":"farruco.sanjurjo","email":"farruco.sanjurjo@gmail.com"},{"name":"felipecoe","email":"felipe@contentful.com"},{"name":"guilebarbosa","email":"guipvb@gmail.com"},{"name":"hollensteiner","email":"claushollensteiner@gmail.com"},{"name":"it-internal","email":"it-internal@contentful.com"},{"name":"jakub-contentful","email":"jakub@contentful.com"},{"name":"johannes_bugiel","email":"johannes.bugiel@contentful.com"},{"name":"johanneswuerbach","email":"johannes.wuerbach@googlemail.com"},{"name":"joshuasmock","email":"f1144756@mvrht.com"},{"name":"jpawlyn","email":"jpawlyn@gmail.com"},{"name":"kgarbaya","email":"kgarbaya@gmail.com"},{"name":"lneves75","email":"luis.neves75@gmail.com"},{"name":"m10l","email":"mike.mitchell@contentful.com"},{"name":"marina-cf","email":"marina.guseva@contentful.com"},{"name":"markuslaut","email":"markus.lautenbach@contentful.com"},{"name":"martzoukos","email":"spiros@contentful.com"},{"name":"medturki","email":"mohamed@contentful.com"},{"name":"ohookins-ctf","email":"oliver@contentful.com"},{"name":"phbschmidt","email":"phoebe.schmidt@contentful.com"},{"name":"poberherr","email":"patrick.oberherr@gmail.com"},{"name":"roboben","email":"ben@contentful.com"},{"name":"ronaldronson","email":"ronald.ronson@outlook.com"},{"name":"sbezludny","email":"serg.bezludny@gmail.com"},{"name":"sey1000","email":"sey.cheon@contentful.com"},{"name":"silhoue","email":"joanna@contentful.com"},{"name":"stefanjudis","email":"stefanjudis@gmail.com"},{"name":"stupchiy","email":"sergiy@contentful.com"},{"name":"suevalov","email":"suevalov.work@gmail.com"},{"name":"thebesson","email":"tankidet@gmail.com"},{"name":"timbeyer","email":"tim.beyer@gmail.com"},{"name":"zcei","email":"stephanschndr@gmail.com"},{"name":"zeusdeux","email":"zeusdeux@gmail.com"}],"homepage":"https://github.com/contentful/rich-text#readme","bugs":{"url":"https://github.com/contentful/rich-text/issues"},"dist":{"shasum":"35c12599ca9ba1445868173c2d7acddee78f17cb","tarball":"https://registry.npmjs.org/@contentful/rich-text-html-renderer-demo/-/rich-text-html-renderer-demo-0.0.0-determined-by-semantic-release.tgz","fileCount":49,"integrity":"sha512-akCBkbWBTQxcXH8mXAWQHuVf5o+AmgqjiTIV/Up6rJq8OTiqiinoOot/OqjFr1D79e7nZQrj5M21qJmcRaBoEg==","signatures":[{"sig":"MEQCICS+hqf1q5weBvs7IGSk+KrLVe6kGZj+Ny2pAjhDBzjkAiAgRrk42NPsDcgQhQrjH1lb6tnRhRutXk1mb+ela9u7Eg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":68712,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJb0xqlCRA9TVsSAnZWagAA61AQAI8bDpjuupoUwqn0K7K9\nxNvbKxOWG8LsYeWePXVi2byJ06MtsF0AOXP+1hzcfcTqeN2jAUWHP9HymTWI\n9RejbAeM7JmGYoH9UjMji8XAGuIGfatnOsZNMELZ/9jcTdAaE5kqYtr7eRtF\nAJqnk48tu9A+Aev6bt/aB2pq89D+DUBUzs8uDVzjdFAL/EEHG3hgDZDNdcgV\nYaT0GU76aXk0IEDcwJhyXTbqE9+uNOLwbQH+r4ba7FUnsu13CDamjANy0XJF\nqI9bN0EMOVum/TF0fXTJivIR4mRG/y5jgwsqB4yqePU9iMtj7JcD6kLiOfhp\nbiRCAtIzQJzNVGZg0hQObBxymIuoAk0u65q2esTyI/kzNrBIFSJxhMii8dgB\nUUddY9oUL5STtS5rEiaRT/w2KkXU9cA7D68ICQpqwEyttkkEv8KPcEw+zfO2\nB0KIhEF9Le9IYqDdX4GkT5vzCh8yhS6HqC+n40i3z2ktdOmksrXhfNvpVOaA\nRaImVBDWzZMY7usggDN5yUshQhNvxWvvfoZCqfHcJE6MFUpiLnojfQQyCTWs\nJO3njhTjZWN1P03P/KIvps7a32VrxiQFqCgDXZer0Q0vRpuxaVXcTgAiDlQM\nHgBsvPSGttq4azDM3B7mLOewPS2vIBJMHXN0/JUHVWdpi/ZPfo084Tz/oW3q\nETNZ\r\n=XnxN\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/rich-text-html-renderer-demo.es5.js","engines":{"node":">=6.0.0"},"scripts":{"build":"tsc --module commonjs && rollup -c rollup.config.js","start":"tsc && rollup -c rollup.config.js -w","prebuild":"rimraf dist","report-coverage":"cat ./coverage/lcov.info | coveralls"},"typings":"dist/types/rich-text-html-renderer-demo.d.ts","_npmUser":{"name":"cribbles","email":"csloop@wesleyan.edu"},"repository":{"url":"git+https://github.com/contentful/rich-text.git","type":"git"},"_npmVersion":"6.4.1","description":"HTML renderer for the Rich Text document.","directories":{},"_nodeVersion":"8.11.1","dependencies":{"@semantic-release/git":"6.0.2","@semantic-release/npm":"3.4.1","semantic-release-monorepo":"^6.1.1","@semantic-release/changelog":"2.1.2","@contentful/rich-text-types-demo":"^0.0.0-determined-by-semantic-release"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^23.6.0","faker":"^4.1.0","husky":"^1.1.2","colors":"^1.1.2","git-cz":"^1.7.1","prompt":"^1.0.0","rimraf":"^2.6.2","rollup":"^0.66.6","tslint":"^5.11.0","ts-jest":"^23.10.4","ts-node":"^7.0.1","prettier":"^1.14.3","coveralls":"^3.0.2","cross-env":"^5.2.0","commitizen":"^3.0.4","typescript":"^2.6.2","@types/jest":"^22.0.0","@types/node":"^10.0.3","lint-staged":"^7.3.0","@types/faker":"^4.1.2","replace-in-file":"^3.4.2","lodash.camelcase":"^4.3.0","semantic-release":"15.6.3","@types/lodash.omit":"^4.5.3","rollup-plugin-json":"^3.1.0","travis-deploy-once":"^5.0.9","validate-commit-msg":"^2.14.0","@types/lodash.flatmap":"^4.5.3","rollup-plugin-commonjs":"^9.2.0","tslint-config-prettier":"^1.15.0","tslint-config-standard":"^8.0.1","rollup-plugin-sourcemaps":"^0.4.2","cz-conventional-changelog":"^2.1.0","rollup-plugin-typescript2":"^0.17.2","rollup-plugin-node-resolve":"^3.4.0"},"_npmOperationalInternal":{"tmp":"tmp/rich-text-html-renderer-demo_0.0.0-determined-by-semantic-release_1540561572035_0.8718978917040316","host":"s3://npm-registry-packages"}}},"time":{"created":"2018-10-26T12:31:22.900Z","modified":"2026-05-28T10:22:06.603Z","6.0.11111":"2018-10-26T12:31:23.285Z","0.0.0-determined-by-semantic-release":"2018-10-26T13:46:12.329Z"},"bugs":{"url":"https://github.com/contentful/rich-text/issues"},"license":"MIT","homepage":"https://github.com/contentful/rich-text#readme","repository":{"url":"git+https://github.com/contentful/rich-text.git","type":"git"},"description":"HTML renderer for the Rich Text document.","maintainers":[{"email":"it-internal@contentful.com","name":"it-internal"},{"email":"npm@contentful.com","name":"whydah-gally"},{"email":"team-mechagodzilla@contentful.com","name":"contentful-ecosystem"},{"email":"michael.pearce@contentful.com","name":"michaelpearce"}],"readme":"# rich-text-html-renderer-demo\nHTML renderer for the Rich Text document.\n\n## Installation\nUsing [npm](http://npmjs.org/):\n\n```javascript\nnpm install @contentful/rich-text-html-renderer-demo\n```\n\nUsing [yarn](https://yarnpkg.com/):\n```javascript\nyarn add @contentful/rich-text-html-renderer-demo\n```\n\n## Usage\n\n```javascript\nimport { documentToHtmlString } from '@contentful/rich-text-html-renderer-demo';\n\nconst document = {\n  nodeType: 'document',\n  nodeClass: 'document',\n  content: [\n    {\n      nodeClass: 'block',\n      nodeType: 'paragraph',\n      content: [\n        {\n          nodeClass: 'text',\n          nodeType: 'text',\n          value: 'Hello world!',\n          marks: [],\n        },\n      ],\n    },\n  ]\n};\n\ndocumentToHtmlString(document); // -> <p>Hello world!</p>\n```\n\n```javascript\nimport { documentToHtmlString } from '@contentful/rich-text-html-renderer-demo';\n\nconst document = {\n  nodeType: 'document',\n  nodeClass: 'document',\n  content: [\n    {\n      nodeClass: 'block',\n      nodeType: 'paragraph',\n      content: [\n        {\n          nodeClass: 'text',\n          nodeType: 'text',\n          value: 'Hello',\n          marks: [{ nodeType: 'bold' }]\n        },\n        {\n          nodeClass: 'text',\n          nodeType: 'text',\n          value: ' world!',\n          marks: [{ nodeType: 'italic' }]\n        },\n      ],\n    },\n  ]\n};\n\ndocumentToHtmlString(document); // -> <p><b>Hello</b><u> world!</u></p>\n```\n\nYou can also pass custom renderers for both marks and nodes as an optional parameter like so:\n\n```javascript\nimport { BLOCKS.PARAGRAPH, MARKS.BOLD } from '@contentful/rich-text-types-demo';\nimport { documentToHtmlString } from '@contentful/rich-text-html-renderer-demo';\n\nconst document = {\n  nodeType: 'document',\n  nodeClass: 'document',\n  content: [\n    {\n      nodeClass: 'block',\n      nodeType: 'paragraph',\n      content: [\n        {\n          nodeClass: 'text',\n          nodeType: 'text',\n          value: 'Hello',\n          marks: [{ nodeType: 'bold' }]\n        },\n        {\n          nodeClass: 'text',\n          nodeType: 'text',\n          value: ' world!',\n          marks: [{ nodeType: 'italic' }]\n        },\n      ],\n    },\n  ]\n};\n\nconst options = {\n  renderMark: {\n    [MARKS.BOLD]: text => `<custom-bold>${text}<custom-bold>`\n  },\n  renderNode: {\n    [BLOCKS.PARAGRAPH]: (node, next) => `<custom-paragraph>${next(node.content)}</custom-paragraph>`\n  }\n}\n\ndocumentToHtmlString(document, options);\n// -> <custom-paragraph><custom-bold>Hello</custom-bold><u> world!</u></custom-paragraph>\n```\n\nLast, but not least, you can pass a custom rendering component for an embedded entry:\n\n```javascript\nimport { BLOCKS.EMBEDDED_ENTRY } from '@contentful/rich-text-types-demo';\nimport { documentToHtmlString } from '@contentful/rich-text-html-renderer-demo';\n\nconst document = {\n  nodeType: 'document',\n  nodeClass: 'document',\n  content: [\n    {\n      nodeClass: 'block',\n      nodeType: 'embedded-entry-block',\n      data: {\n        target: (...)Link<'Entry'>(...);\n      },\n    },\n  ]\n};\n\nconst options = {\n  renderNode: {\n    [BLOCKS.EMBEDDED_ENTRY]: (node) => `<custom-component>${customComponentRenderer(node)}</custom-component>`\n  }\n}\n\ndocumentToHtmlString(document, options);\n// -> <custom-component>(...)Link<'Entry'>(...)</custom-component>\n```\n\nThe `renderNode` keys should be one of the following `BLOCKS` and `INLINES` properties as defined in [`@contentful/rich-text-types-demo`](https://www.npmjs.com/package/@contentful/rich-text-types-demo):\n* `BLOCKS`\n  * `DOCUMENT`\n  * `PARAGRAPH`\n  * `HEADING_1`\n  * `HEADING_2`\n  * `HEADING_3`\n  * `HEADING_4`\n  * `HEADING_5`\n  * `HEADING_6`\n  * `UL_LIST`\n  * `OL_LIST`\n  * `LIST_ITEM`\n  * `QUOTE`\n  * `HR`\n  * `EMBDEDDED_ENTRY`\n* `INLINES`\n  * `EMBEDDED_ENTRY` (this is different from the `BLOCKS.EMBEDDED_ENTRY`)\n  * `HYPERLINK`\n  * `ENTRY_HYPERLINK`\n  * `ASSET_HYPERLINK`\n\nThe `renderMark` keys should be one of the following `MARKS` properties as defined in [`@contentful/rich-text-types-demo`](https://www.npmjs.com/package/@contentful/rich-text-types-demo):\n\n  * `BOLD`\n  * `ITALIC`\n  * `UNDERLINE`\n  * `CODE`\n","readmeFilename":"README.md"}