\n\n# `solid-markdown`\n\nRender markdown as solid components.\n\nThe implementation is 90% shamelessly copied from https://github.com/remarkjs/react-markdown.\n\nChanges include:\n\n- Replacing React specific component creation with SolidJS components\n- Porting the implementation from javascript with JSDoc types to typescript\n\nPlease check the original repo for in-depth details on how to use.\n\n## Installation\n```bash\nnpm install solid-markdown\n```\n\n\n## Usage\n\n```jsx\nimport { SolidMarkdown } from \"solid-markdown\";\n\nconst markdown = `\n# This is a title\n\n- here's\n- a\n- list\n`;\nconst App = () => {\n return ;\n};\n```\n\n## Rendering strategy\nThere's an extra option you can pass to the markdown component: `renderingStrategy: \"memo\" | \"reconcile\"`.\n\nThe default value is `\"memo\"`, which means that the markdown parser will generate a new full AST tree each time (inside a `useMemo`), and use that.\nAs a consequence, the full DOM will be re-rendered, even the markdown nodes that haven't changed. (Should be fine 90% of the time).\n\nUsing `reconcile` will switch the strategy to using a solid store with the `reconcile` function (https://docs.solidjs.com/reference/store-utilities/reconcile). This will diff the previous and next markdown ASTs and only trigger re-renders for the parts that have changed.\nThis will help with cases like streaming partial content and updating the markdown gradually (see https://github.com/andi23rosca/solid-markdown/issues/32).\n\n\n```tsx\n;\n```\n\n## TODO\n\n- [ ] Port unit tests from from original library\n","readmeFilename":"README.md"}
![\"solid-markdown\"](\"https://assets.solidjs.com/banner?type=solid-markdown&background=tiles&project=%20\")
\n