markdown-component-loader将Markdown转为React组件
Markdown 的文档变组件这事,其实早就有人搞了,但markdown-component-loader做得还挺干净的,配合 React 用起来蛮顺手。它能把.md 文件直接转成无状态的 React 组件,响应快,代码结构也清晰,适合做那种带交互的文档站或组件库文档。
安装也简单,yarn add markdown-component-loader
或 npm install --save markdown-component-loader
,配好Webpack 和 Babel就能直接用。Webpack 那边要加个 loader 配置,基本照文档贴代码就行,没啥坑。
你可以在 Markdown 里直接嵌React 组件,比如写个按钮组件展示交互,或者传个 prop 实时变 UI,效果挺直观。比起写死的文档,动态组件文档更贴合现代需求。
适合那种写文档又想展示真实组件的场景,比如设计系统、组件库、或内部开发手册。有点像 Vue 生态的 vue-markdown-loader 或 vue-md-loader,但这个是为React量身定做的。
如果你项目本身用的是React + Webpack,而且文档比较多,想整合在一起展示,那这个 loader 可以考虑上。顺带提醒一句,记得 Markdown 里别写太花哨的语法,组件解析时会冲突。
markdown-component-loader-develop.zip
预估大小:80个文件
markdown-component-loader-develop
文件夹
.gitignore
80B
README.md
9KB
.github
文件夹
workflows
文件夹
node.js.yml
533B
docs
文件夹
site.js.map
51KB
repl.js.LICENSE.txt
602B
site.js
20KB
...
5.29MB
文件大小:
评论区