{"_id":"@bluedocs/markdown-renderer","name":"@bluedocs/markdown-renderer","dist-tags":{"latest":"0.1.0"},"versions":{"0.1.0":{"name":"@bluedocs/markdown-renderer","version":"0.1.0","main":"dist/index.js","module":"dist/index.es.js","typings":"dist/index.d.ts","keywords":["markdown","md","renderer"],"description":"Vue3 Markdown 渲染器","homepage":"https://github.com/BlueDocs/markdown-renderer","repository":{"type":"git","url":"git+https://github.com/BlueDocs/markdown-renderer.git"},"license":"MIT","author":{"name":"Fansy","email":"418536538@qq.com"},"devDependencies":{"@fansy/eslint-config":"^1.0.0","@fansy/prettier-config":"^1.0.0","@types/node":"^18.7.18","@vitejs/plugin-vue":"^3.1.0","@vitejs/plugin-vue-jsx":"^2.0.1","rimraf":"^3.0.2","vite":"^3.1.1","vite-plugin-dts":"^1.5.0","vue":"^3.2.39"},"dependencies":{"highlight.js":"^11.6.0","vc-state":"^1.1.0"},"peerDependencies":{"vue":">= 3.0.0"},"scripts":{"build":"vite build"},"bugs":{"url":"https://github.com/BlueDocs/markdown-renderer/issues"},"_id":"@bluedocs/markdown-renderer@0.1.0","_integrity":"sha512-FdBnBfg40B1Eqpc7J47FLoD7b0hSgMlpjMSfMW5ACYYLlQ22lLb+2W4TVDQ0T+pBU+brTrdkmxPaDWOn5YxidA==","_resolved":"/private/var/folders/k3/ybrq2zmj09jdkhl9lyxzfr1c0000gn/T/db7f9fce5ee807bf2555a1f35d03f115/bluedocs-markdown-renderer-0.1.0.tgz","_from":"file:bluedocs-markdown-renderer-0.1.0.tgz","_nodeVersion":"18.9.0","_npmVersion":"8.19.1","dist":{"integrity":"sha512-FdBnBfg40B1Eqpc7J47FLoD7b0hSgMlpjMSfMW5ACYYLlQ22lLb+2W4TVDQ0T+pBU+brTrdkmxPaDWOn5YxidA==","shasum":"11077fa595e677115a25ec943710cc1d29c7e8fb","tarball":"https://registry.npmjs.org/@bluedocs/markdown-renderer/-/markdown-renderer-0.1.0.tgz","fileCount":25,"unpackedSize":30745,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFJ/DGwMeUSoaxnT/beLU+4BVoqzjSU6Mp2p3PeYsS8IAiEA9vZfAhRCXsqFnCaJsQ0G7KjC4L2hTuPn2OOXdV6c8XQ="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjJgBWACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmrE2A/+NX0hjwr9faPMrCvtefRTi2Etd6BnSDB23LgJt8+3UWLvQ7lw\r\nvoGoTfXYA8iwSPGTXHQhJ3uIFN07RPnkc7V06iSNnAUGwX7w1889xmMZq7aY\r\n28NLzrv3sFOJFkqlTBH7HP1UpKFff9D1XczuywNZtzWRatVLWM6XjJxtiiWm\r\nPMr67RJp4yIl6Ov9FzyTk+7KG6w7j188jbXLenCMIGWVgm5tJuDzf4/3GomC\r\nqCqFz5L6Vik6PfhS7y+uhINbfT2KzlTHAumMOfuqdv+Arjo3X1Og5R6ZFjQo\r\nqcA4w/8gCtExFYbWL4WpupUADZxB4aTHe5uyXCp/vx/63T98oiy+Hpf7P1KO\r\nQ8e1RUoE10XIunhNZ6IVoGUW0UZdBNZOgXPMT4Ao3ytQ70AN34i6YcK2xad3\r\nFr4MsmLrtgxotDaSv7WYRNDS+Fa9Ci9GX3GMNzsFbG3NsKwr8tQBISYoRtXi\r\nCmTAN83VZKVQ5/j/3cnUXaHf8o9I+yEiuilU8pLACnCy6ZyEF4iG6huNP7+H\r\nmaizfzjLKOQBXJZ1guAEH7g3R34Sap1SwftrqcFyeanPynDdFIIMCPUu01gr\r\n9BvvKQ6ZaYiQgf/rc+cdQbfdSrPUc8aeDnVwxWRiY2N2exKtbLb5JclzKZlC\r\n+b9r3/KPTn+ug671aFQw3Xx1X0zQkMs91R8=\r\n=+RIG\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"fanhaoyuan","email":"418536538@qq.com"},"directories":{},"maintainers":[{"name":"fanhaoyuan","email":"418536538@qq.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/markdown-renderer_0.1.0_1663434837951_0.6070927919700069"},"_hasShrinkwrap":false}},"time":{"created":"2022-09-17T17:13:57.903Z","0.1.0":"2022-09-17T17:13:58.179Z","modified":"2022-09-17T17:13:58.332Z"},"maintainers":[{"name":"fanhaoyuan","email":"418536538@qq.com"}],"description":"Vue3 Markdown 渲染器","homepage":"https://github.com/BlueDocs/markdown-renderer","keywords":["markdown","md","renderer"],"repository":{"type":"git","url":"git+https://github.com/BlueDocs/markdown-renderer.git"},"author":{"name":"Fansy","email":"418536538@qq.com"},"bugs":{"url":"https://github.com/BlueDocs/markdown-renderer/issues"},"license":"MIT","readme":"# Markdown Renderer\n\nMarkdown 文档渲染器\n\n## 安装\n\n```bash\n# npm\n>$ npm install @bluedocs/markdown-renderer --save\n\n# yarn\n>$ yarn add @bluedocs/markdown-renderer\n\n# pnpm\n>$ pnpm add @bluedocs/markdown-renderer\n```\n\n## 使用\n\n### 基础渲染\n\n```tsx\nimport { MarkdownRendererContextProvider, MarkdownRenderer } from '@bluedocs/markdown-renderer';\n\nexport default defineComponent({\n    name: 'App',\n    setup() {\n        const md = '## Hello World';\n\n        return () => {\n            return (\n                <MarkdownRendererContextProvider>\n                    <MarkdownRenderer content={md} />\n                </MarkdownRendererContextProvider>\n            );\n        };\n    },\n});\n```\n\n### Token 渲染\n\n```tsx\nimport { MarkdownRendererContextProvider, MarkdownTokenRenderer, parse } from '@bluedocs/markdown-renderer';\n\nexport default defineComponent({\n    name: 'App',\n    setup() {\n        const md = '## Hello World';\n\n        return () => {\n            return (\n                <MarkdownRendererContextProvider>\n                    <MarkdownTokenRenderer tokens={parse(md)} />\n                </MarkdownRendererContextProvider>\n            );\n        };\n    },\n});\n```\n\n## 自定义渲染组件\n\n### useMarkdownRendererContext\n\n在自定义组件中，可以使用 `useMarkdownRendererContext` 来获取渲染器的上下文\n\n```tsx\nimport { defineComponent } from ';\nimport { useMarkdownRendererContext } from '@bluedocs/markdown-renderer';\n\n// Heading.tsx\nexport const Heading = defineComponent({\n    name: 'Heading',\n    setup(props, { slots }) {\n        const context = useMarkdownRendererContext();\n\n        return () => <h1 class={`${context.namespace}-heading`}>{slots.default?.()}</h1>;\n    },\n});\n\n// App.tsx\nimport { MarkdownRendererContextProvider, MarkdownRenderer } from '@bluedocs/markdown-renderer';\n\nexport default defineComponent({\n    name: 'App',\n    setup() {\n        const md = '## Hello World';\n\n        return () => {\n            return (\n                <MarkdownRendererContextProvider components={{ h1: attrs => <Heading {...attrs} /> }}>\n                    <MarkdownRenderer content={md} />\n                </MarkdownRendererContextProvider>\n            );\n        };\n    },\n});\n```\n\n## 许可证\n\n[MIT](./LICENSE)\n","readmeFilename":"README.md"}