{"_id":"@tryfabric/martian","_rev":"5-a71247c488e260272a8a088fad1402a2","name":"@tryfabric/martian","dist-tags":{"latest":"1.2.4"},"versions":{"1.1.0":{"name":"@tryfabric/martian","version":"1.1.0","description":"Converts Markdown to Notion Blocks and RichText","repository":{"type":"git","url":"git+https://github.com/instantish/martian.git"},"main":"build/src/index.js","types":"build/src/index.d.ts","scripts":{"test":"jest","lint":"gts lint","clean":"gts clean","compile":"tsc","fix":"gts fix","prepare":"npm run compile","pretest":"npm run compile","posttest":"npm run lint"},"keywords":["markdown","notion","parser","gfm"],"engines":{"node":">=15"},"author":{"name":"Richard Robinson"},"license":"ISC","dependencies":{"@notionhq/client":"^0.4.5","remark-gfm":"^1.0.0","remark-parse":"^9.0.0","unified":"^9.2.1"},"devDependencies":{"@types/jest":"^27","@types/node":"^15.12.4","gts":"^3.1.0","jest":"^27.0.4","ts-jest":"^27.0.3","ts-node":"^10.0.0","typescript":"^4.3.4"},"gitHead":"e5e604aefdb942f86da45ec7148ab9056bc2c54e","bugs":{"url":"https://github.com/instantish/martian/issues"},"homepage":"https://github.com/instantish/martian#readme","_id":"@tryfabric/martian@1.1.0","_nodeVersion":"16.11.1","_npmVersion":"8.0.0","dist":{"integrity":"sha512-fqXP8+oZtf5DDwote7OlNA3JgLmyGSqQYzMyWJ+vNDIZgeoL2u+s7/D9ucW+tAjzoi6hLpoR8QpUk4sDkojiww==","shasum":"5ddd0881c6e1bafc3bbe8d4f161cc3e4bdf35d88","tarball":"https://registry.npmjs.org/@tryfabric/martian/-/martian-1.1.0.tgz","fileCount":54,"unpackedSize":121340,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIHMUPKO3fB4t8vSTPbSj27NCdOlqoKjM8eDAbDl2r6NgAiAYFpHfwXcMBV0GwqCYgiUc9Z4Njr8g1qhA55GMQREYDg=="}]},"_npmUser":{"name":"juliarosenson","email":"julia.rosenson@gmail.com"},"directories":{},"maintainers":[{"name":"juliarosenson","email":"julia.rosenson@gmail.com"},{"name":"marissamary","email":"marissa@tryfabric.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/martian_1.1.0_1636044472904_0.6050870646259994"},"_hasShrinkwrap":false},"1.1.1":{"name":"@tryfabric/martian","version":"1.1.1","description":"Converts Markdown to Notion Blocks and RichText","repository":{"type":"git","url":"git+https://github.com/instantish/martian.git"},"main":"build/src/index.js","types":"build/src/index.d.ts","scripts":{"test":"jest","lint":"gts lint","clean":"gts clean","compile":"tsc","fix":"gts fix","prepare":"npm run compile","pretest":"npm run compile","posttest":"npm run lint"},"keywords":["markdown","notion","parser","gfm"],"engines":{"node":">=15"},"author":{"name":"Richard Robinson"},"license":"ISC","dependencies":{"@notionhq/client":"^0.4.5","remark-gfm":"^1.0.0","remark-parse":"^9.0.0","unified":"^9.2.1"},"devDependencies":{"@types/jest":"^27","@types/node":"^15.12.4","gts":"^3.1.0","jest":"^27.0.4","ts-jest":"^27.0.3","ts-node":"^10.0.0","typescript":"^4.3.4"},"publishConfig":{"access":"public"},"gitHead":"085769ed2de70f053a3f2fa95e696698aaa540ec","bugs":{"url":"https://github.com/instantish/martian/issues"},"homepage":"https://github.com/instantish/martian#readme","_id":"@tryfabric/martian@1.1.1","_nodeVersion":"17.0.1","_npmVersion":"8.1.0","dist":{"integrity":"sha512-7EC6np65doCeaJHubyoJzYa8dykKw069QQwV1AdRce0Epw4+eOfXQcYmmXnNHpvJYCctst/Nkjo0lQA6H1UPqQ==","shasum":"95d149f537a7d86247c8907c28f7383520281872","tarball":"https://registry.npmjs.org/@tryfabric/martian/-/martian-1.1.1.tgz","fileCount":55,"unpackedSize":128390,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhs5AwCRA9TVsSAnZWagAAd/IP/1DQSyL6Lh1YgZIMCuEu\nTWWG+n0mNqlG7LTxj4UtgOXgYgyySfZ5OcNV1t0XHfY+LpZ5vRrXEjupCDr2\nxdMvJhkx+sJxMbQ+gQ5GkyCTSNHTScFs62v8xcSFi/lSVjJBagjIOY42lHnn\nGwItKM9RLwtwT3mZp3/i0VPrpRGuMAXDw9URfmreB4XI2jkvo5no79oKZxG7\nOZkOW2tGGQneKd3TMoKgXe72+CwH10MQfAwWmyuZ+MbEFh4N3DVYzvzAAiC8\niRwPHKF1JyG6PlgvyvlHaqaJOJXKd3PYb5XAU/w8/Y3ABCrMKAYyeRwrcDFZ\nyZIkmxFon4jNy1PqNH1tyxEqMu0RjPLioaO9dv1k8Iujo2GX2ojRsrrf+Mq7\nTGSKGQwMuqXyJ+tGBcQxhgWvUg0MSX7LEg7Lm9QorejOmmRY7CcHuqUAhgxs\n5vXibFHq+Be4zOGT/WSz23TUz+KaHNzRn5sPpD87Y168HZDc9fhHzlPtm3yN\nfhp5aVaDpHQ5RKLQIBggqK/XFxGdNR6ldhifLZuQoH41pYPIC2iudCv5q5sm\n5hfuI6hLcihwXbtopan81aNdGa/Ggm+IZ63r4sF24OlL77g13p8TDHqut+hi\nlshbkvJgzyNb5Yh6jsXCFPJ/0+77VzP5IvTaE/Do55E0twUDDDA8/dZ5rfZd\nxwds\r\n=9XdW\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBBi4zIXRfqinPiw3upq2b/oO6z088i7PMvONIiZE347AiAAx8uVilmfDvvLXGmNBYony9i/0Z+e0EEGQ9nlIA/p0g=="}]},"_npmUser":{"name":"marissamary","email":"marissa@tryfabric.com"},"directories":{},"maintainers":[{"name":"juliarosenson","email":"julia.rosenson@gmail.com"},{"name":"marissamary","email":"marissa@tryfabric.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/martian_1.1.1_1639157807865_0.653004106757304"},"_hasShrinkwrap":false},"1.2.0":{"name":"@tryfabric/martian","version":"1.2.0","description":"Converts Markdown to Notion Blocks and RichText","repository":{"type":"git","url":"git+https://github.com/instantish/martian.git"},"main":"build/src/index.js","types":"build/src/index.d.ts","scripts":{"test":"jest","lint":"gts lint","clean":"gts clean","precompile":"ts-node scripts/languageMap.ts","compile":"tsc","fix":"gts fix","prepare":"npm run compile","pretest":"npm run compile","posttest":"npm run lint"},"keywords":["markdown","notion","parser","gfm"],"engines":{"node":">=15"},"author":{"name":"Richard Robinson"},"license":"ISC","dependencies":{"@notionhq/client":"^1.0.4","remark-gfm":"^1.0.0","remark-parse":"^9.0.0","unified":"^9.2.1"},"devDependencies":{"@types/jest":"^27","@types/node":"^15.12.4","gts":"^3.1.0","jest":"^27.0.4","linguist-languages":"^7.15.0","ts-jest":"^27.0.3","ts-node":"^10.0.0","typescript":"^4.3.4"},"publishConfig":{"access":"public"},"gitHead":"1a4e1636f4cdc1e6bf878c45c35dc0b47d2ccf7f","bugs":{"url":"https://github.com/instantish/martian/issues"},"homepage":"https://github.com/instantish/martian#readme","_id":"@tryfabric/martian@1.2.0","_nodeVersion":"16.14.0","_npmVersion":"8.3.1","dist":{"integrity":"sha512-q3grnGgwfujNZelpK6uMswObYKSy1dY+yKypgjl7EPxpSvSHlJb1f0gIfghGUWf1gVxZfHfSZDe+k9KCzaLbwQ==","shasum":"5d4055fdf516b2c6a56e93b05d635694f85056b6","tarball":"https://registry.npmjs.org/@tryfabric/martian/-/martian-1.2.0.tgz","fileCount":62,"unpackedSize":181740,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiQxoDACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmp//A/+J7Q75NTnQEYI5rcFbNfIYUbSt2SsfvnxjaBxNyku6z5Yadcn\r\nHJDuENiKvGV7lqzZEk/O/RP5aJvNxIhrCT9tfamzcoMYb/NanvK1RrG4vzEr\r\ni8/u4JXs5XkXVLYhgj6vpGdhvHYrogZA9Q/IZGN7J7WSXAHAeS8otlt1o2st\r\nJC4qr/+5eJCN6lGPTTMMbDBmKDB6Jnv16rqGFSAn0M3dLMOHeKuWlOOQmDoh\r\nE69Qpz3HIkgHrRLFfq3CJ2ovuSJipOSS0jNyDEsRRCdKW1yMQDmR8N1WvF/J\r\nClki4d0cfHpN3+EW4ZoeR6z/xaRC5bOpE9p0WetqPs7E0KeBueb3EvkkX0Y9\r\n7RG7oQDBOL+SqBiR+V1x/KRXT/BtalteeJ1DZXeDzYpLqTGBvz51eWdOsPD8\r\nlt5Cei9SUz9+imVhCH+pt9aN4Brt67xdlS3E7Nkpeu/R6jljmUY9OiayQIZW\r\n7KKESHX2zWx/UxAFUHv/QmMq0InQhBf83hejZINEss9YcSji3X3HI3afC/0c\r\nJP0qtQZxo4bnwKY6nSttaM6KLZW6Df43hHoZg4yZwg1qnFkPOSJ0QBXLvclF\r\nrzjl5mXmMQbX5G44mB3AxMieQ+mQaoQxjVCwaZvzM94RX5RP63+TVp1VXlqu\r\nJ2ZEwf6l6u4g9esZJBhZ1hBF1r2ueRYV/dw=\r\n=hJj/\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIEht8dyp+n2kmMqebkWErvlaUKJMdokkBIq054snnlvxAiAMcvWEzlG6uWW5fDPXidRNIpUbs+q9yEJ4XGCttqJKlA=="}]},"_npmUser":{"name":"marissamary","email":"marissa@tryfabric.com"},"directories":{},"maintainers":[{"name":"juliarosenson","email":"julia.rosenson@gmail.com"},{"name":"marissamary","email":"marissa@tryfabric.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/martian_1.2.0_1648564739637_0.49388892567419185"},"_hasShrinkwrap":false},"1.2.4":{"name":"@tryfabric/martian","version":"1.2.4","description":"Converts Markdown to Notion Blocks and RichText","repository":{"type":"git","url":"git+https://github.com/tryfabric/martian.git"},"main":"build/src/index.js","types":"build/src/index.d.ts","scripts":{"test":"jest","lint":"gts lint","clean":"gts clean","precompile":"ts-node scripts/languageMap.ts","compile":"tsc","fix":"gts fix","prepare":"npm run compile","pretest":"npm run compile","posttest":"npm run lint"},"keywords":["markdown","notion","parser","gfm"],"engines":{"node":">=15"},"author":{"name":"Richard Robinson"},"license":"ISC","dependencies":{"@notionhq/client":"^1.0.4","remark-gfm":"^1.0.0","remark-math":"^4.0.0","remark-parse":"^9.0.0","unified":"^9.2.1"},"devDependencies":{"@types/jest":"^27","@types/node":"^15.12.4","gts":"^3.1.0","jest":"^27.0.4","linguist-languages":"^7.15.0","ts-jest":"^27.0.3","ts-node":"^10.0.0","typescript":"^4.3.4"},"publishConfig":{"access":"public"},"gitHead":"ce527e106359f2c5cab5ddc146f545c8eb608ce1","bugs":{"url":"https://github.com/tryfabric/martian/issues"},"homepage":"https://github.com/tryfabric/martian#readme","_id":"@tryfabric/martian@1.2.4","_nodeVersion":"16.15.0","_npmVersion":"8.5.5","dist":{"integrity":"sha512-g7SP7beaxrjxLnW//vskra07a1jsJowqp07KMouxh4gCwaF+ItHbRZN8O+1dhJivBi3VdasT71BPyk+8wzEreQ==","shasum":"3fdfe7129f1c28bccddc34854cf353b0f37c0c02","tarball":"https://registry.npmjs.org/@tryfabric/martian/-/martian-1.2.4.tgz","fileCount":63,"unpackedSize":185335,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDo4QBahvGAZMdP3d8gFGM9H4C3aDY0yZXRHfMX4Z2DvQIgEQlgfnmAXVat8VbAOseu35HRr05OYBz0p2kf7L2QMGI="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJijQBSACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmo0XA/+JPFuaD3RAj/2uGuM+skigQoEDIjNnj149t2W1iO5JALQ6mfj\r\nMMNQETXuXp23sw4UUS1P1/eS0pa+7SqEEnxjuswu8urdldSHMnoMWMvtYvnE\r\nioAnAV5zuc0PYY/7MuA9zbMbd66faijUvBxQLd0iIpRyDS4r5aakP0NrsE1P\r\nwvvhzFqf64YFZjWGrsm6US/aQh8B691PyL5mWhazkZ6K4d5V2IMzpMxzGnTi\r\n9aivJsj4nlksyVZMmHwCGp3uZoDfsKRhcOMNtld8rPxl2YsouIZY8VIoRq48\r\nqmfgYGfnr9uAHhnWVeyPVWa01XLaV1DLmhBiFx03tFZKK0ipsWBaWxYurFkl\r\n69hX98rvLFHgFe+0bQKmCDBk+PiejcaLYZa6x9xvwE1FF3NznglIEee+KHjm\r\nGkpLYHYGa4+xH6hvXzQVbyOHpc0qjevnesXh0iTZXeJT0ihmaWqkdhdYX+NP\r\nQqhmf27Ge8BlWBfgW7RIpVVavqNL92p0aycsJ29JIA5xEJEieeo9uYLLf+Hu\r\nr36UpKCfJ3eqaTp7YqvvlWWeeG9EDHzwXw9aWsA2fuBOfcB59dFpN743opYb\r\n3UenT5cBuw1BBNR7nhy70AiTxyky6Ag3bQKwmZSYDnZWHY5KYSbEbM/aaPgW\r\nzEvry0cXLgpEUltK/LdHbJY0OhMBUBpr22w=\r\n=WFt6\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"marissamary","email":"marissa@tryfabric.com"},"directories":{},"maintainers":[{"name":"endbug","email":"fgrandi30@gmail.com"},{"name":"juliarosenson","email":"julia.rosenson@gmail.com"},{"name":"marissamary","email":"marissa@tryfabric.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/martian_1.2.4_1653407826164_0.8748385026304095"},"_hasShrinkwrap":false}},"time":{"created":"2021-11-04T16:47:52.858Z","1.1.0":"2021-11-04T16:47:53.074Z","modified":"2022-05-24T15:57:06.478Z","1.1.1":"2021-12-10T17:36:48.113Z","1.2.0":"2022-03-29T14:38:59.799Z","1.2.4":"2022-05-24T15:57:06.396Z"},"maintainers":[{"name":"endbug","email":"fgrandi30@gmail.com"},{"name":"juliarosenson","email":"julia.rosenson@gmail.com"},{"name":"marissamary","email":"marissa@tryfabric.com"}],"description":"Converts Markdown to Notion Blocks and RichText","homepage":"https://github.com/tryfabric/martian#readme","keywords":["markdown","notion","parser","gfm"],"repository":{"type":"git","url":"git+https://github.com/tryfabric/martian.git"},"author":{"name":"Richard Robinson"},"bugs":{"url":"https://github.com/tryfabric/martian/issues"},"license":"ISC","readme":"# Martian: Markdown to Notion Parser\n\nConvert Markdown and GitHub Flavoured Markdown to Notion API Blocks and RichText.\n\n[![Node.js CI](https://github.com/tryfabric/martian/actions/workflows/ci.yml/badge.svg)](https://github.com/tryfabric/martian/actions/workflows/ci.yml)\n[![Code Style: Google](https://img.shields.io/badge/code%20style-google-blueviolet.svg)](https://github.com/google/gts)\n\nMartian is a Markdown parser to convert any Markdown content to Notion API block or RichText objects. It\nuses [unified](https://github.com/unifiedjs/unified) to create a Markdown AST, then converts the AST into Notion\nobjects.\n\nDesigned to make using the Notion SDK and API easier. Notion API version 1.0.\n\n### Supported Markdown Elements\n\n- All inline elements (italics, bold, strikethrough, inline code, hyperlinks, equations)\n- Lists (ordered, unordered, checkboxes) - to any level of depth\n- All headers (header levels >= 3 are treated as header level 3)\n- Code blocks, with language highlighting support\n- Block quotes\n- Tables\n- Equations\n- Images\n - Inline images are extracted from the paragraph and added afterwards (as these are not supported in notion)\n - Image urls are validated, if they are not valid as per the Notion external spec, they will be inserted as text for you to fix manually\n\n## Usage\n\n### Basic usage:\n\nThe package exports two functions, which you can import like this:\n\n```ts\n// JS\nconst {markdownToBlocks, markdownToRichText} = require('@tryfabric/martian');\n// TS\nimport {markdownToBlocks, markdownToRichText} from '@tryfabric/martian';\n```\n\nHere are couple of examples with both of them:\n\n```ts\nmarkdownToRichText(`**Hello _world_**`);\n```\n\n
\nResult\n
\n[\n  {\n    \"type\": \"text\",\n    \"annotations\": {\n      \"bold\": true,\n      \"strikethrough\": false,\n      \"underline\": false,\n      \"italic\": false,\n      \"code\": false,\n      \"color\": \"default\"\n    },\n    \"text\": {\n      \"content\": \"Hello \"\n    }\n  },\n  {\n    \"type\": \"text\",\n    \"annotations\": {\n      \"bold\": true,\n      \"strikethrough\": false,\n      \"underline\": false,\n      \"italic\": true,\n      \"code\": false,\n      \"color\": \"default\"\n    },\n    \"text\": {\n      \"content\": \"world\"\n    }\n  }\n]\n
\n
\n\n```ts\nmarkdownToBlocks(`\nhello _world_ \n*** \n## heading2\n* [x] todo\n`);\n```\n\n
\nResult\n
\n[\n  {\n    \"object\": \"block\",\n    \"type\": \"paragraph\",\n    \"paragraph\": {\n      \"rich_text\": [\n        {\n          \"type\": \"text\",\n          \"annotations\": {\n            \"bold\": false,\n            \"strikethrough\": false,\n            \"underline\": false,\n            \"italic\": false,\n            \"code\": false,\n            \"color\": \"default\"\n          },\n          \"text\": {\n            \"content\": \"hello \"\n          }\n        },\n        {\n          \"type\": \"text\",\n          \"annotations\": {\n            \"bold\": false,\n            \"strikethrough\": false,\n            \"underline\": false,\n            \"italic\": true,\n            \"code\": false,\n            \"color\": \"default\"\n          },\n          \"text\": {\n            \"content\": \"world\"\n          }\n        }\n      ]\n    }\n  },\n  {\n    \"object\": \"block\",\n    \"type\": \"heading_2\",\n    \"heading_2\": {\n      \"rich_text\": [\n        {\n          \"type\": \"text\",\n          \"annotations\": {\n            \"bold\": false,\n            \"strikethrough\": false,\n            \"underline\": false,\n            \"italic\": false,\n            \"code\": false,\n            \"color\": \"default\"\n          },\n          \"text\": {\n            \"content\": \"heading2\"\n          }\n        }\n      ]\n    }\n  },\n  {\n    \"object\": \"block\",\n    \"type\": \"to_do\",\n    \"to_do\": {\n      \"rich_text\": [\n        {\n          \"type\": \"text\",\n          \"annotations\": {\n            \"bold\": false,\n            \"strikethrough\": false,\n            \"underline\": false,\n            \"italic\": false,\n            \"code\": false,\n            \"color\": \"default\"\n          },\n          \"text\": {\n            \"content\": \"todo\"\n          }\n        }\n      ],\n      \"checked\": true\n    }\n  }\n]\n
\n
\n\n### Working with Notion's limits\n\nSometimes a Markdown input would result in an output that would be rejected by the Notion API: here are some options to deal with that.\n\n#### An item exceeds the children or character limit\n\nBy default, the package will try to resolve these kind of issues by re-distributing the content to multiple blocks: when that's not possible, `martian` will truncate the output to avoid your request resulting in an error. \nIf you want to disable this kind of behavior, you can use this option:\n\n```ts\nconst options = {\n notionLimits: {\n truncate: false,\n },\n};\n\nmarkdownToBlocks('input', options);\nmarkdownToRichText('input', options);\n```\n\n#### Manually handling errors related to Notions's limits\n\nYou can set a callback for when one of the resulting items would exceed Notion's limits. Please note that this function will be called regardless of whether the final output will be truncated.\n\n```ts\nconst options = {\n notionLimits: {\n // truncate: true, // by default\n onError: (err: Error) => {\n // Something has appened!\n console.error(err);\n },\n },\n};\n\nmarkdownToBlocks('input', options);\nmarkdownToRichText('input', options);\n```\n\n### Working with images\n\nIf an image as an invalid URL, the Notion API will reject the whole request: `martian` prevents this issue by converting images with invalid links into text, so that request are successfull and you can fix the links later. \nIf you want to disable this kind of behavior, you can use this option:\n\n```ts\nconst options = {\n strictImageUrls: false,\n};\n```\n\nDefault behavior:\n\n```ts\nmarkdownToBlocks('![](InvalidURL)');\n```\n\n
\nResult\n
\n[\n  {\n    \"object\": \"block\",\n    \"type\": \"paragraph\",\n    \"paragraph\": {\n      \"rich_text\": [\n        {\n          \"type\": \"text\",\n          \"annotations\": {\n            \"bold\": false,\n            \"strikethrough\": false,\n            \"underline\": false,\n            \"italic\": false,\n            \"code\": false,\n            \"color\": \"default\"\n          },\n          \"text\": {\n            \"content\": \"InvalidURL\"\n          }\n        }\n      ]\n    }\n  }\n]\n
\n
\n\n`strictImageUrls` disabled:\n\n```ts\nmarkdownToBlocks('![](InvalidURL)', {\n strictImageUrls: false,\n});\n```\n\n
\nResult\n
\n[\n  {\n    \"object\": \"block\",\n    \"type\": \"image\",\n    \"image\": {\n      \"type\": \"external\",\n      \"external\": {\n        \"url\": \"InvalidURL\"\n      }\n    }\n  }\n]\n
\n
\n\n---\n\nBuilt with 💙 by the team behind [Fabric](https://tryfabric.com).\n\n\n\n### Non-inline elements when parsing rich text\n\nBy default, if the text provided to `markdownToRichText` would result in one or more non-inline elements, the package will ignore those and only parse paragraphs. \nYou can make the package throw an error when a non-inline element is detected by setting the `nonInline` option to `'throw'`.\n\nDefault behavior:\n\n```ts\nmarkdownToRichText('# Header\\nAbc', {\n // nonInline: 'ignore', // Default\n});\n```\n\n
\nResult\n
\n[\n  {\n    type: 'text',\n    annotations: {\n      bold: false,\n      strikethrough: false,\n      underline: false,\n      italic: false,\n      code: false,\n      color: 'default'\n    },\n    text: { content: 'Abc', link: undefined }\n  }\n]\n
\n
\n\nThrow an error:\n\n```ts\nmarkdownToRichText('# Header\\nAbc', {\n nonInline: 'throw',\n});\n```\n\n
\nResult\n
\nError: Unsupported markdown element: {\"type\":\"heading\",\"depth\":1,\"children\":[{\"type\":\"text\",\"value\":\"Header\",\"position\":{\"start\":{\"line\":1,\"column\":3,\n\"offset\":2},\"end\":{\"line\":1,\"column\":9,\"offset\":8}}}],\"position\":{\"start\":{\"line\":1,\"column\":1,\"offset\":0},\"end\":{\"line\":1,\"column\":9,\"offset\":8}}}  \n
\n
\n","readmeFilename":"README.md"}