npm 是前端开发必备的包管理工具之一,有许多优秀的 npm 包可以让我们更高效地完成开发工作。这篇文章介绍一个特别有用的 npm 包:readme-button-generator,它可以帮助我们快速生成漂亮的 README 按钮。
为什么要使用 readme-button-generator?
README 是我们开发者输出给别人的一份文档,它可以让使用者更好地理解我们的项目。在 README 中,增加一些漂亮的按钮能够让使用者更好的了解我们的项目,以及更快速地使用起来。readme-button-generator 可以让我们快速生成一些常见的按钮,如 GitHub Star、NPM 版本、Travis CI 状态等等。使用它,我们不必手动生成这些按钮,这极大地提升了我们的效率。
安装和使用
使用 readme-button-generator 很简单,首先在你的项目中安装它,可以通过在命令行中运行以下命令:
npm install -g readme-button-generator
然后,用以下代码生成一个 GitHub Star 按钮:
[![GitHub stars](https://img.shields.io/github/stars/<repo>.svg)](https://github.com/<repo>/stargazers)
其中,<repo>
是你的 GitHub 仓库名。
同样,我们可以生成其他的按钮:
[![npm version](https://img.shields.io/npm/v/<package>.svg)](https://www.npmjs.com/package/<package>) [![Build Status](https://travis-ci.org/<repo>.svg?branch=master)](https://travis-ci.org/<repo>) [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/<repo>/blob/master/LICENSE)
其中,<package>
是你的 npm 包名。
示例
下面是一个完整的 README 例子,包括几个 readme-button-generator 生成的按钮:
-- -------------------- ---- ------- - ---------- ------ ------------------------------------------------------------------------------------------------ -------- ---------------------------------------------------------------------------------------------------------------------- --------- ----------------------------------------------------------------------------------------------------------------------------- - ----- ----------- -- -- -------- -- -------- - ------- - - ------- - -- ----- --- ------------ ------------ ------------ --- ----------- --- ------- ---------- --- --- --- ------------- --- ----------- -- ------- --------------------------------------------------------------------
总结
readme-button-generator 可以帮我们节省大量的时间,让我们更快速地生成漂亮的按钮。如果你想让你的 README 更加专业,这个工具绝对是你的不二之选!
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60055d2b81e8991b448dae1a