在编写npm包时，编写一个清晰完整的README.md文件是非常重要的。一个优秀的README文件可以帮助用户了解你的npm包的功能，怎样使用以及帮助使用者更快速的上手。然而，对于初学者而言，如何编写一个好的README文件？这时，readme-senpai 这个npm包就派上了用场。
什么是 readme-senpai
readme-senpai 是一个npm包，用于帮助你编写好的readme文件，它有以下两个主要功能点：
- 通过生成table of content，使得你的markdown文件结构更加清晰明了。
- 给每个markdown标题添加样式，使您的README看起来更加美观和专业。
如何使用 readme-senpai
使用readme-senpai非常简单，只需要在使用npm管理器安装该包即可，在终端输入以下npm命令行：
npm install readme-senpai --save-dev
安装完成后，我们可以按照以下步骤进行使用：
1.编写一个README.md文件
首先，你自己编写一个README.md文件即可，原始状态下的读者可能会感到一些混乱，如下：
-- -------------------- ---- ------- - ---- -- -- --- -- --- -- -- -- --- -- --- -- -- -- --- -- --- -- --- -- -- -- --- ---- --- ----
2.根据官方文档，添加Table of Contents
-- -------------------- ---- -------
---------
- -------------
- ---------
- ---------
- ---------
- ---------
- ---------
- ---------
- ---------
- ---------
- ---------
- ---------
- ---------
- -------------
- -------------
---------3. 在README.md中添加一个代码注释，告诉readme-senpai如何添加样式：
-- -------------------- ---- ------- ------------------------------- ---------- --- -- ---- --- -- -- ---- ---- -- ---- ---- -- --- -- -- ---- ---- -- ---- ---- -- --- ---- ---- ---- -- ---- ---- -- ---- ---- -- --- -- -- ---- ---- ---- ---- ---- ---- ---
4. 运行readme-senpai
接下来时间运行readme-senpai，指定readme的路径， 以及添加样式之后，生成一个新的README:
npx readme-senpai --path=./README.md --out=./README-toc.md --style=./readme.css
5. 看一下生成的新README
生成的README-toc.md看上去是这样的：
-- -------------------- ---- ------- ------------------------------- --- -- ---- --- -- -- ---- ---- -- ---- ---- -- --- -- -- ---- ---- -- ---- ---- -- --- ---- ---- ---- -- ---- ---- -- ---- ---- -- --- -- -- ---- ---- ---- ---- ---- ----
其中，我们看到添加的样式，已经生成了我们期望的的效果了，就如下面的截图一样。
总结
readme-senpai是一个非常有用的工具，帮助了我们从繁杂的markdown文件中生成结构清晰与美观的readme，有效提高程序员的文档质量。在开发npm包的时候，我们应该掌握如何优雅清晰的撰写readme文件来为使用者提供更加文档化的服务，最后祝你开发出更加优秀的npm包与documentation。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055da181e8991b448db5cf