在前端开发中，我们经常需要把代码文档化以便于团队协作以及后期维护。而@stembord/react-document就是一个方便快捷的npm包，帮助开发者生成React组件的文档。
什么是@stembord/react-document
@stembord/react-document是一个基于React.js的组件文档生成器，它允许你快速创建组件文档以及展示实际演示（demo）。该npm包支持ES6、TypeScript以及flow等语言，且在性能上表现优秀，使得它成为当前最为优秀的组件文档生成器之一。
使用步骤
步骤一: 安装@stembord/react-document
通过npm命令安装@stembord/react-document
npm install @stembord/react-document --save-dev
步骤二: 创建你的文档
在你的项目中创建一个*.md*文件，并在其中编辑你想要的文档内容，你可以写入任何你想写的Markdown格式文档，比如：
-- -------------------- ---- ------- - ----------- -- ------- ----- -------------------------- -- ----- - ---- - ---- - ------- - -------- - ----------- - - --- - --- - --- - --- - --- - - --- - ------ - --- - --- - - ---- --- --- - -- ----- ----- ------ ----- ---- -------- ------ ------------- ---- --------------- ------ ------- -------- ----- - ------ ------------- --------- ---- -
-- -------------------- ---- -------
--------------------------------------------------------
------
------ ----- ---- --------
------ -------- ---- ---------------------------
----- ----------- - -- -- -
------ -
---------
----------------------------------- -- -------
------------------------------------- -- -------
--
--
--
------ ------- ------------步骤三: 编写你的演示代码
你可以使用任何你喜欢的方式来编写你的演示代码，但因为文档器是基于React的，所以我们推荐您使用TypeScript或JavaScript来编写示例代码。在文件中，您只需要编写有用的React代码，文档器会自动为您重写和渲染Example组件。
步骤四: 预览你的文档
现在您已经完成了文档的编写、演示、组件的实现，接下来您只需要执行以下命令可以在你的浏览器中预览你的文档，并且通过该文档是否迎来来判断你的文档是否已经实现：
npm install npm start
示例程序
Example.js
-- -------------------- ---- -------
------ ----- ---- --------
------ -------- ---- ---------------------------
----- ------- - -- -- -
------ -
---------
----------------------------------- -- -------
------------------------------------- -- -------
--
--
--
------ ------- --------MyComponentDemo.tsx
-- -------------------- ---- -------
------ ----- ---- --------
------ ----------- ---- ---------------------------
------ ------- -------- ----------------- -
------ -
---- ---------------- -----
------------ -----------
------
--
-结语
使用@stembord/react-document来为您的React组件生成文档可以让您的团队更加高效地进行协作。它能够帮助您快速创建组件文档并渲染演示，这样您就可以确信您的组件库的每个组件都具有有效的文档，并且可以为使用者带来更好的体验。无论是在开发歇息，前期学习，还是后续使用，该npm包对于我们来说都有着非常重要的作用。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60067355890c4f7277583ba5